Skip to content

Conversation

dhrgit
Copy link
Contributor

@dhrgit dhrgit commented Sep 3, 2019

Reason for This PR

Release v0.18.0.

Description of Changes

  • Fixed some typos left behind in docs/vsock.md.
  • Updated CHANGELOG.md with all user-facing changes since v0.17.0.
  • Fixed CHANGELOG.md (line length) formatting.
  • Updated Firecracker version via devtool prepare_release.

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license.

PR Checklist

  • All commits in this PR are signed (git commit -s).
  • Either this PR is linked to an issue, or, the reason for this PR is
    clearly provided.
  • The description of changes is clear and encompassing.
  • Either no docs need to be updated as part of this PR, or, the required
    doc changes are included in this PR. Docs in scope are all *.md files
    located either in the repository root, or in the docs/ directory.
  • Either no code has been touched, or, code-level documentation for touched
    code is included in this PR.
  • Either no API changes are included in this PR, or, the API changes are
    reflected in firecracker/swagger.yaml.
  • Either the changes in this PR have no user impact, or, the changes in
    this PR have user impact and have been added to the CHANGELOG.md file.

@dhrgit dhrgit self-assigned this Sep 3, 2019
- Updated the documentation for integration tests.
- Fixed high CPU usage before guest network interface is brought up (GitHub
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally do not like the mentioning of the Github issue and I do not see value added. :( We have not done it until now and if we do it now, does that mean we will do it for every release?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm.. I think it'd be cool to have the issue number here so people can easily find it for more details.

But like @dianpopa said, if we do this here we need to be consistent and add it for every Fixed entry and every Added entry where we can reference an issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found mentioning the GitHub issue helpful for traceability reasons. The value that I see added is that one may look up more detailed information pertaining to a particular change (i.e. fix/change/addition). Without the GitHub reference, I find gathering that information to be much more challenging.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with having it, but let's be consistent. At the very least, the

  • New device: virtio-vsock, backed by Unix domain sockets. See docs/vsock.md.

entry needs the GitHub issue as well. A lot of the early design details are in issue #650

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

alxiord
alxiord previously approved these changes Sep 4, 2019
- Updated the documentation for integration tests.
- Fixed high CPU usage before guest network interface is brought up (GitHub
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with having it, but let's be consistent. At the very least, the

  • New device: virtio-vsock, backed by Unix domain sockets. See docs/vsock.md.

entry needs the GitHub issue as well. A lot of the early design details are in issue #650

@acatangiu
Copy link
Contributor

Also rebase on top of master since you're changing files anyway (save some CI time).

alxiord
alxiord previously approved these changes Sep 4, 2019
Fixed a couple of typos in `docs/vsock.md`.

Signed-off-by: Dan Horobeanu <dhr@amazon.com>
Updated `CHANGELOG.md` with the user-facing changes merged since
v0.17.0.

Signed-off-by: Dan Horobeanu <dhr@amazon.com>
Ran `devtool prepare_release` for new version v0.18.0.

Signed-off-by: Dan Horobeanu <dhr@amazon.com>
@dhrgit dhrgit merged commit 1e1cb6f into firecracker-microvm:master Sep 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants