-
-
Notifications
You must be signed in to change notification settings - Fork 304
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
Use towncrier for changelog generation #2736
Conversation
Thanks, @dstansby! I love this. A few questions from my side since I've not used it in anger:
|
One thing I like about our current system is that I can go to the latest changelog to see what is going into the next release. How would we do that using this system? |
I put back the PR labeler, which now checks for files changed in
Yes, it happens when
I guess they could do, but they get rendered the same as before (RST lists), so this PR doesn't change how we want to write the messages one way or another.
👍 - I altered the readthedocs build to render all the unreleased fragments, so you can see them on the release notes page: https://zarr--2736.org.readthedocs.build/en/2736/release-notes.html |
Sounds good, guess we just need to be careful of too complex files that inject chaos into the README. As @d-v-b, I imagine some form of style examples might be worth long-term. Anyhoo, this rocks. |
Note that #2681 put its note in the right place before merge, but of course that changelog line will need dealing with when this gets merged. |
Since I think I've dealt with all the feedback/suggestions, and there's no objections, should we merge this to avoid stuff getting further out of sync with new PRs? |
This changes the system of adding changelog entries from updating a single
.rst
file, to adding individual.rst
files to achanges
directory. At release time, these are then all automatically collated usingtowncrier
. This has the advantages of:releaset-notes.rst
during developmentFor the release manager this is not much extra effort. Before, the changelog version already needed manually updating and commiting, with this PR the changelog just needs generating using towncrier and commiting.
Fixes #829