Make minor fixes to release docs#1379
Merged
Merged
Conversation
Closed
Member
|
LGTM. Should we cut a |
Contributor
Author
|
Not sure exactly what you mean by "cut a post release". My normal inclination would be to wait a few days to make sure no critical bugs get reported, then go ahead and merge #1342. Although as you say, we could merge sooner and just release any fixes from a branch if necessary. |
Member
|
Since this PR includes changes to the docs but not the actual software, it may be appropriate to make a post release (e.g. |
This file contains hidden or 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
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.
Summary of changes
I made some tweaks to the release process documentation after using it to create version 39.2.0. I also updated the 39.2.0 changelog to reflect one item which was omitted because the file was named incorrectly (which prompted one of the doc updates).
The towncrier output is slightly inconsistent in its usage of newlines between preview and release modes, and edits to the template don't seem to affect this. I manually added one newline and removed another for the 39.2.0 release to keep the formatting consistent; the new output review step is partially to catch things like this until we find a way to get towncrier to automatically get the formatting correct.
The
--allow-dirtyoption is needed for bump2version to go ahead even though the changelog updates haven't been committed yet.Pull Request Checklist