Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make minor fixes to release docs #1379

merged 1 commit into from
May 19, 2018


Copy link

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-dirty option is needed for bump2version to go ahead even though the changelog updates haven't been committed yet.

Pull Request Checklist

  • News fragment added in changelog.d. See documentation for details

@jmbowman jmbowman mentioned this pull request May 19, 2018
Copy link

LGTM. Should we cut a post release before landing #1342, or just cut any subsequent patch releases from a branch?

@pganssle pganssle merged commit e74c482 into master May 19, 2018
@jmbowman jmbowman deleted the jmbowman/release_docs_fix branch May 19, 2018 20:20
Copy link
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.

Copy link

Since this PR includes changes to the docs but not the actual software, it may be appropriate to make a post release (e.g. 39.2.0.post1), but I guess it doesn't matter, since redirects to the latest, not the stable version of the documentation, so I guess it doesn't make sense to make docs-only releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants