Repository navigation
Release notes: a PR can replace the notes of the PRs it renames or changes (Supersedes release note:) - #1015
Merged
Merged
Conversation
A PR that renames or changes a feature an earlier PR in the same release added can list those PRs; the collector drops their notes (and their entries in the full list) so the release never names a feature that no longer exists. Chains collapse, out-of-range PRs get a notice, every drop is logged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Release note: none
Summary
v0.2.0's notes carried the
Release note:lines of PRs whose feature a later PR in the same release renamed (thedodstudio_*commands after #719 renamed them tods_*). A PR body can now say which earlier notes it replaces:release_notes.pydrops every listed PR that is in the same release range from the grouped notes and from the full PR list, and the superseding PR's own note stands for it.Release note:: case-insensitive,notestoo, bold / list forms; numbers with or without#, commas or spaces; several lines add up; HTML comments ignored (so the template hint never counts).notice:line saying its note is already out.release notes: #731 dropped: superseded by #1013, plusN supersededin the summary line.docs/versioning_and_releases.md, a commented hint under theRelease note:line in.github/pull_request_template.md, one sentence in CLAUDE.md'sRelease note:bullet. No workflow changes.Test done
python -m unittest discover -s .github/scripts -p "test_*.py"(the CI step's command):Ran 45 tests ... OK. New:ExtractSuperseded(line forms, several lines, comments / mid-line mentions, does not count as the release note, the repo template's hint is not a line) andSupersedes(drop + log + render, out-of-range notice, chain, no-note warning for bothnoneand a missing line, full list, cycle, self-reference).python .github/scripts/release_notes.py --target origin/dev --output <scratch>printedrelease notes: v0.2.0..42a3bd1829: 70 PRs, 53 with a release note(no PR on dev carries the new line yet, so nothing dropped).Decisions
none): still drops the listed PRs (the author chose that, e.g. a PR that removes a feature), and prints awarning:naming only the dropped PRs that actually had a note. The script has no existing convention that fits better.--outputisn't given.🤖 Generated with Claude Code