Skip to content

chore: Release notes: exclude internal refactors, publish all breaking changes, strip tool attribution - #9280

Merged
Jason3S merged 2 commits into
mainfrom
chore/release-notes-rules
Sep 27, 2026
Merged

Jason3S merged 2 commits into
mainfrom
chore/release-notes-rules

Conversation

@Jason3S

@Jason3S Jason3S commented Sep 27, 2026 •

Copy link
Copy Markdown
Collaborator

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.yml autolabeler)

  • refactor: and dev: titles get the refactor label, which moves from include-labels to exclude-labels. Internal refactors no longer appear under Fixes.
  • Any type!: or type(scope)!: title gets breaking. Before, only unscoped feat!:/fix!: did, so fix(cspell-lib)!: shipped as a patch and refactor!:/perf!: were hidden with no major bump.
    • refactor!: and dev!: no longer get refactor, so they aren't excluded.
    • chore!:, ci!:, and test!: stay out: their own labels are excluded.
  • A revert gets fix only when it undoes a published type: Revert "feat: ...", revert: fix(scope)!: ..., and so on. Reverts of chore:, refactor:, or ci: 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

replacers remove these from the release body, which also feeds CHANGELOG.md and 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 it
  • a bare https://claude.ai/code/session_... link

These 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.mts checks 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.
  • The check-release-drafter.yml workflow runs it on PRs that change these files, and by hand. It is not part of pnpm test.

…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.
@Jason3S Jason3S changed the title chore: Release notes: exclude internal refactors, label reverts and scoped breaking changes, strip tool attribution chore: Release notes: exclude internal refactors, publish all breaking changes, strip tool attribution Sep 27, 2026
@Jason3S
Jason3S merged commit 0c41db6 into main Sep 27, 2026
13 checks passed
@Jason3S
Jason3S deleted the chore/release-notes-rules branch September 27, 2026 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant