Add CHANGELOG.md #1010
Add CHANGELOG.md #1010
Conversation
Add step to consider updating CHANGELOG.md Revise ticket auditing to remove suggestion that ticket titles are used in release notes.
There was a problem hiding this comment.
This reminds of a nicer version of csv2cl and svn2cl. I like the utility of this for users and I also like that it doesn't just reproduce the git commit history (since lots of changes aren't interesting to users).
Do you need an approval so that you can merge this, or are you still thinking about other related changes in this PR or something like that?
I am not planning on making more changes. At least one approval is needed to merge. I plan to ask for opinions in the team channel again before merging. |
OK. I'll add a LGTM so that you can merge when you're ready. |
Summary
This PR proposes adding a changelog to track notable changes in releases.
Changes were tested by locally tagging a commit with
r3.9.0and temporarily tweaking the script to produce a draft. Here is a sample draft of the produced release notes:https://github.com/mongodb/mongo-cxx-driver/releases/tag/untagged-fd8ab6ba4086415ac8fa
Background & Motivation
Having a CHANGELOG may reduce work during releases:
make_release.py. Notes can be written incrementally with the changes.Listing individual Jira tickets is intentionally removed. IMO a copied list of tickets does not provide much value over linking to Jira. Providing a high level overview of changes may be more helpful. Readers can follow the Jira link or see commits for details.