-
Notifications
You must be signed in to change notification settings - Fork 543
Include post-release updates to CHANGELOG.md
in release process
#1109
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
Conversation
…checking out branch For a minor release, update `CHANGELOG.md` on `master`. For a patch release, update `CHANGELOG.md` on the release branch.
It is tracked on the release branch
New changes are proposed in https://github.com/mongodb/mongo-cxx-driver/pull/1112/files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updates to the releasing.md were made after running through the 3.10.1 release. #1112 contains proposed post-release updates for 3.10.1.
If the changelog is updated on the release branch in the pre-release step for the patch release, the updates may need to be applied again during the post-release step.
Co-authored-by: Ezra Chung <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Retracted many of the suggestions given in prior review after discussions revealed concerns with the timing of the release tag w.r.t. creation and updates to the master and release branch.
To clarify that the branch is intended to be created from `master`
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides one comment regarding clarifying what branch we should be on prior to editing documentation + minor suggestions, LGTM.
Co-authored-by: Ezra Chung <[email protected]>
Co-authored-by: Ezra Chung <[email protected]>
Co-authored-by: Ezra Chung <[email protected]>
Co-authored-by: Ezra Chung <[email protected]>
Co-authored-by: Ezra Chung <[email protected]>
Co-authored-by: Ezra Chung <[email protected]>
Summary
This PR is intended to specify consistent updates the
CHANGELOG.md
when releasing:CHANGELOG.md
[Unreleased]
sections for subsequent releases after a release.As a drive-by improvement
make_release.py
is updated to ignore the "Release<version>
" ticket when checking for open tickets.This PR is associated with:
#1108#1107 to add a CHANGELOG.md entry for the upcoming 3.10.1 release.Background & Motivation
There are no instructions for updating CHANGELOG.md after a release. This resulted in a follow-up PR to update CHANGELOG.md with the 3.10.0 section: #1105