fix: unify changelogs #1241
Merged
fix: unify changelogs #1241
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
this should make all changes appear in the same changelog
Pull Request Test Coverage Report for Build 18205580520Details
💛 - Coveralls |
grdsdev
approved these changes
Oct 3, 2025
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.
What kind of change does this PR introduce?
Unify all CHANGELOG files into a single one, and change the release-please setup to use a single package in root (".") instead of subpackages. With this change, release-please should generate a release PR with a single set of changes, containing all of them, instead of the weird thing that keeps happening where some changes are picked up by the release-please algorithm while others are not (and we end up needing to manually modify it).
By using the "extra-files" tag in release-please-config.json, we can ensure that it always keep the versions in pyproject.toml and version.py up to date.
I primed the root CHANGELOG to warn people that it has been unified since 2.21.0, and that for older versions the CHANGELOGS should be looked in the sub packages' CHANGELOG, which should remain unaltered as a reference piece.
I did manage to manually test this with release-please CLI in dry-run mode and I believe that the PRs it will generate are going to be correct.