Skip to content

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

Merged
merged 34 commits into from
Mar 7, 2024

Conversation

kevinAlbs
Copy link
Collaborator

@kevinAlbs kevinAlbs commented Mar 4, 2024

Summary

This PR is intended to specify consistent updates the CHANGELOG.md when releasing:

  • Tag the commit updating CHANGELOG.md
  • Add [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

…checking out branch

For a minor release, update `CHANGELOG.md` on `master`. For a patch release, update `CHANGELOG.md` on the release branch.
@kevinAlbs kevinAlbs requested a review from eramongodb March 4, 2024 19:06
@kevinAlbs kevinAlbs requested a review from eramongodb March 4, 2024 19:28
Copy link
Collaborator Author

@kevinAlbs kevinAlbs left a 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.

@kevinAlbs kevinAlbs requested a review from eramongodb March 5, 2024 21:13
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]>
Copy link
Contributor

@eramongodb eramongodb left a 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.

@eramongodb eramongodb self-requested a review March 6, 2024 20:58
Copy link
Contributor

@eramongodb eramongodb left a 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.

@kevinAlbs kevinAlbs merged commit 7a8a3e9 into mongodb:master Mar 7, 2024
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.

3 participants