Merge changelog entries for fixups with main PR #15207
Open
+99
−45
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.
The release changelog directly maps all merged PRs to changelog entries. Some PRs are bugfixes or enhancements to other changes. They're less relevant for users because they only affect an intermediary state in the release process. For example, #15178 fixes a regression, but that regression is only in master.
The changelog describes the difference between two releases. So a reader wouldn't even consider this a regression fix because the code that introduced the bug was never released on its own without the fix.
From the perspective of the changelog it makes sense to group related PRs that build on top of each other into a single changelog entry. We had been doing this already previously, when we were writing the changelog manually.
This patch adds support for this to the changelog generator. If a PR title contains the text
[fixup #XXXX]
(where#XXXX
references a PR), its entry gets merged with the referenced PR. The title and labels of the fixup are ignored, only the PR number and author show up in the changelog.Example diff that this change would produce in the changelog for 1.15: