Skip to content

chore: Release notes: leave out docs and website changes - #9288

Merged
Jason3S merged 1 commit into
mainfrom
chore/release-notes-docs-website
Sep 27, 2026
Merged

Jason3S merged 1 commit into
mainfrom
chore/release-notes-docs-website

Conversation

@Jason3S

@Jason3S Jason3S commented Sep 27, 2026

Copy link
Copy Markdown
Collaborator

Summary

Leaves documentation and website changes out of the release notes. The readers are people who use cspell, and they don't need an entry for a docs fix or a site update.

Prefixes

  • docs: is for README files and the repo's docs (docs/, CONTRIBUTING.md). Its documentation label moves from include-labels to exclude-labels.
  • New website: prefix for changes to the site's content. It gets the existing Website label, which is excluded. Website dependency and tooling updates stay chore:.
  • Both spellings of each label are excluded (documentation/Documentation, website/Website), because release-drafter compares label names case-sensitively and the GitHub labels are capitalised.

Labels come from the title only

The website/**/*.md file rule is removed. release-drafter drops a PR if any of its labels is excluded, so once documentation is excluded, a feat: PR that also updates a website page would have been hidden, with no version bump. scripts/check-release-drafter.mts now fails if an autolabeler rule uses files.

Reverts

A revert is published only when it undoes a feat or fix change. docs is removed from the rule, since docs: itself is no longer published.

Check

node ./scripts/check-release-drafter.mts passes 32 titles, including docs:, docs(scope):, docs!:, website:, and Revert "docs: ...". It fails against the previous config on each change above.

The contributor docs describing these rules are updated in #9287, which should merge after this PR.

- `docs:` (README files and repo docs) and the new `website:` prefix (site content) are excluded.
- Labels come from the title only: the `website/**/*.md` file rule could hide a `feat:` or `fix:` PR.
- A revert is published only when it undoes a `feat` or `fix` change.
@github-actions github-actions Bot added the chore label Sep 27, 2026
Jason3S added a commit that referenced this pull request Sep 27, 2026
…ebsite prefixes

- Fix the malformed code spans in docs/releasing.md "Prerelease mode".
- skipLibCheck: prefer false; tsconfig.esm.json sets true because third-party types broke builds.
- Describe the rules from #9288: `docs:` and `website:` are not published, labels come from the title only,
  and reverts are published only for `feat` and `fix`.
- ADR design PRs are `docs:`.
- cli-option and config-option: filter while iterating, then build everything and update all snapshots.
@Jason3S
Jason3S merged commit a09c29a into main Sep 27, 2026
12 checks passed
@Jason3S
Jason3S deleted the chore/release-notes-docs-website branch September 27, 2026 07:59
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