Update changelog #53
Merged
Update changelog #53
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dansimau
reviewed
Oct 3, 2019
dansimau
reviewed
Oct 3, 2019
CHANGELOG.md
Outdated
| * Fix zip slip vulnerability (#47) | ||
|
|
||
| ### Fixed | ||
| * Propagate SIGINT and SIGTERM to terraform (#49) |
There was a problem hiding this comment.
This is more of a code addition/enhancement, I think it should probably go in "Added".
We can also make it say:
* Propagate SIGINT/SIGTERM to Terraform on shut down (avoids stale locks) (#49)
README.md
Outdated
|
|
||
| ## Contributing to astro | ||
|
|
||
| **Releasing a new version** |
There was a problem hiding this comment.
This reads more easily as a list:
**Releasing a new version**
1. Make sure the CHANGELOG is updated
2. Create and push a new tag named `x.x.x` (following [semver](https://semver.org/))
3. The [release action](https://github.com/uber/astro/actions?workflow=release) will automatically build and upload binaries
Also we can add:
**Making and testing changes to the release process**
1. Make your changes to the [release GitHub action workflow file](https://github.com/uber/astro/actions?workflow=release) and push it to a branch
2. Create a new tag pointing to the tip of the branch (name it: `0.0.0-dev`)
3. Push the tag to trigger the action. The action will use the updated config.
4. Delete the tag after testing (`git tag -d 0.0.0-dev; git push --delete origin 0.0.0-dev`)
Disclaimer: I haven't tested the instructions for "Testing the release process" so we should verify that it works before landing (e.g. that the tag name 0.0.0-dev works).
There was a problem hiding this comment.
Also I'm starting to think these runbooks should be in the wiki and we should link to there from the README instead of making the README really long.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update changelog before the 0.5.0 release.