Split the changelog into separate files #18725
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Summary -- During the release today, I noticed that the changelog is finally too long to render at all on GitHub. This PR follows the same splitting procedure as in uv (astral-sh/uv#11510, astral-sh/uv#12099): first splitting the file into one per minor version, and then reversing the contents of each file to start with the breaking release (`changelogs/0.11.x.md` starts with 0.11.0 instead of 0.11.13 as in the old changelog).
MichaReiser
approved these changes
Jun 17, 2025
Member
MichaReiser
left a comment
There was a problem hiding this comment.
Thanks. Can we add some instructions to the release step in the CONTRIBUTING.md. Just so that I won't forget splitting the CHANGELOG when I make the next minor release
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
During the release today, I noticed that the changelog is finally too long to
render at all on GitHub. This PR follows the same splitting procedure as in
uv (astral-sh/uv#11510, astral-sh/uv#12099): first splitting the file into one
per minor version, and then reversing the contents of each file to start with
the breaking release (
changelogs/0.11.x.mdstarts with 0.11.0 instead of0.11.13 as in the old changelog).
For the second part, I used
reverse-changelog.pyfrom the uv repo, so hopefully everything is correct. I spot-checked 0.7.0 at least.