chore(#625): automate GitHub release-notes formatting (#626)

Release notes were hand-edited after every release to turn GitHub's flat
--generate-notes output into the curated Install + Feature/Enhancement/Fix
format. Add scripts/release-notes/format-github-release-notes.cjs to do this
deterministically (classifying each PR by its conventional-commit title
prefix) and wire it into the pre-release, final, and hotfix release steps so
it runs right after `gh release create --generate-notes`.

Closes #625

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Tom Boucher
2026-06-02 19:42:05 -04:00
committed by GitHub
parent 54a4e34b47
commit 9f05625677
5 changed files with 509 additions and 0 deletions

View File

@@ -207,6 +207,27 @@ Fragments are consolidated into `CHANGELOG.md` at release time by the release wo
**Opt-out:** PRs with no user-facing impact (test refactors, lint config changes, CI tweaks, formatting-only changes) can add the `no-changelog` label. The lint honors it. When unsure whether a change is user-facing, **add the fragment**.
### Release notes formatting
GitHub release notes are generated automatically. The release and hotfix
workflows first create the release with `gh release create --generate-notes`,
then run `scripts/release-notes/format-github-release-notes.cjs --apply` to
rewrite the body into the project's curated format: an **Install** block,
followed by **What's Changed** grouped into **Feature** / **Enhancement** /
**Fix** sections (classified by each PR's conventional-commit title prefix —
`feat` → Feature, `fix` → Fix, everything else → Enhancement), then
**New Contributors** and the **Full Changelog** link.
To re-format an existing release by hand (e.g. backfilling an older release):
```bash
node scripts/release-notes/format-github-release-notes.cjs \
--tag vX.Y.Z --repo open-gsd/gsd-core --apply
```
Omit `--apply` to print the reformatted body to stdout for review without
publishing.
## Documentation Updates — Update the Relevant Docs
If your PR adds, changes, deprecates, or removes user-visible behavior, you **must** update the relevant documentation in `docs/`. CI will fail any PR whose changeset fragment is typed `Added`, `Changed`, `Deprecated`, or `Removed` without also modifying at least one file under `docs/` ([#3213](https://github.com/open-gsd/gsd-core/issues/3213)).