Repository navigation
chore: Release notes: exclude internal refactors, publish all breaking changes, strip tool attribution - #9280
Merged
Merged
Conversation
…coped breaking changes, strip tool attribution - `refactor:` and `dev:` titles get the `refactor` label, which is now excluded from the release notes. - `revert:` and `Revert "..."` titles get `fix`. - Scoped breaking titles such as `fix(cspell)!:` get `breaking`. - A replacer removes "Generated with [Tool](url)" lines from the release body and the CHANGELOG files. - `scripts/check-release-drafter.mts` checks these rules, run by a workflow when the config changes.
…l Claude Code footers - Any `type!:` title gets `breaking`; `refactor!:` and `dev!:` are no longer excluded. - A revert is published only when it undoes a `feat`, `fix`, or `docs` change. - Remove "_Generated by [Tool](...)_" lines, the `---` above them, and bare Claude Code session links. - Drop `workflow_call` from the check workflow: it has a concurrency group and nothing calls it.
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.
Summary
Keeps maintainer-only changes out of the release notes, publishes every breaking change, and strips tool attribution from the notes. A check script and workflow guard these rules.
Labels (
.github/release-drafter.ymlautolabeler)refactor:anddev:titles get therefactorlabel, which moves frominclude-labelstoexclude-labels. Internal refactors no longer appear under Fixes.type!:ortype(scope)!:title getsbreaking. Before, only unscopedfeat!:/fix!:did, sofix(cspell-lib)!:shipped as a patch andrefactor!:/perf!:were hidden with no major bump.refactor!:anddev!:no longer getrefactor, so they aren't excluded.chore!:,ci!:, andtest!:stay out: their own labels are excluded.fixonly when it undoes a published type:Revert "feat: ...",revert: fix(scope)!: ..., and so on. Reverts ofchore:,refactor:, orci:changes get no label and stay out.perf:stays unlabelled on purpose: it is used for performance tests.Excluded PRs are also left out of version resolution (release-drafter v7.7.0), which is why a breaking change must not carry an excluded label.
Tool attribution
replacersremove these from the release body, which also feedsCHANGELOG.mdand the Prepare Release PR. Each is removed only on a line of its own:Generated with [Tool](https://...), with an optional emoji_Generated by [Tool](https://...)_, and a---line directly above ithttps://claude.ai/code/session_...linkThese are the footer formats in Claude Code PRs in inject-markdown and cspell-parsers. A session link inside a sentence, and any other
---, are kept.The patterns are literal block scalars, so toggling prerelease mode (
set-prerelease-mode.mts) leaves the file byte-identical.Check
scripts/check-release-drafter.mtschecks 29 sample titles for their labels and whether they are published, and checks a real footer against what must be removed and kept. It parses patterns the way release-drafter v7.7.0 does, and fails against the previous config on each gap above.check-release-drafter.ymlworkflow runs it on PRs that change these files, and by hand. It is not part ofpnpm test.