fix(changelog): include non-leading release metadata - #1472
Open
yangfan-yf-yf wants to merge 1 commit into
Open
Conversation
yangfan-yf-yf
marked this pull request as ready for review
July 25, 2026 08:16
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
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.
Purpose
Fixes #1471. The default changelog templates omit a breaking-change description or release notice when it belongs to a commit that is not the first commit in its category.
Rationale
The existing dotted attribute path
1.0selects only index 0 from each category. The templates now flatten every category's commit list before filtering forbreaking_descriptionsandrelease_notices.How did you test?
pytest tests/unit/semantic_release/changelog/test_default_changelog.py -q: 34 passed.pytest tests/unit/semantic_release/changelog -m unit -q: 139 passed, 15 skipped; 7 pre-existing Windows newline expectation failures remain intest_release_notes.py, outside this change's code path.How to Verify
pytest tests/unit/semantic_release/changelog/test_default_changelog.py -k nonleading -vv.mdandrstcases pass.PR Completion Checklist