Repository navigation
ci: add automated release notes generation - #2018
Merged
Haven Xia (HavenXia) merged 1 commit intoOct 1, 2026
Merged
Conversation
Steven Shriver (stshrive)
force-pushed
the
dev/release-notes
branch
from
September 30, 2026 20:39
e1ecbec to
b69df4f
Compare
Steven Shriver (stshrive)
force-pushed
the
dev/release-notes
branch
from
September 30, 2026 22:30
b69df4f to
b2cda1a
Compare
- Add `docs/dev/labels/README.md` as the canonical label taxonomy
for issues and pull requests,
- Add two new labels: `breaking-change` and `release-note/none`.
- The `kind/*` and `area/*` definitions come from the triage-issues
skill, which now point at the `labels/README.md`
- Add .github/release.yml so GitHub's generated release notes follow
the `v0.2.0` layout:
- Breaking Changes
- Bug Fixes
- Documentation
- per-area feature sections
- Dependencies
- Other Changes.
- `docs/dev/release-notes.md` covers the sections, PR titles, and the
release steps.
- Points to the new doc content via PR template and CONTRIBUTING
- Enforces that a PR contains a label for release note generation.
- Runs `hack/release/check-pr-labels.sh` against a PR's labels to ensure
it has one `kind/*` label (or `dependencies` / `release-note/none`), an
`area/*` label for features and breaking changes, and no contradictory
pair.
- Pushing `vX.Y.Z` or `vX.Y.Z-PRE` runs `hack/release/draft-release.sh`
which creates a draft release (a prerelease for -PRE tags) with notes
from `.github/release.yml` plus a committer list, as in `v0.1.0` and
`v0.2.0`. **A maintainer edits and publishes the draft.**
Steven Shriver (stshrive)
force-pushed
the
dev/release-notes
branch
from
October 1, 2026 02:02
b2cda1a to
2b8a8f9
Compare
Steven Shriver (stshrive)
marked this pull request as ready for review
October 1, 2026 02:15
Steven Shriver (stshrive)
requested review from
Benjamin Elder (BenTheElder),
Haven Xia (HavenXia) and
Anna Pendleton (annapendleton)
October 1, 2026 16:27
Anna Pendleton (annapendleton)
approved these changes
Oct 1, 2026
Anna Pendleton (annapendleton)
left a comment
Anna Pendleton (annapendleton)
left a comment
Collaborator
There was a problem hiding this comment.
ty for getting this out so quickly!
2 tasks done
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.
breaking-changeandrelease-note/none.v0.2.0layout:docs/dev/release-notes.mdcovers the sections, PR titles, and the release steps.vX.Y.ZorvX.Y.Z-PRErunshack/release/draft-release.shwhich creates a draft release (a prerelease for -PRE tags) with notes from.github/release.ymlplus a committer list, as inv0.1.0andv0.2.0. A maintainer edits and publishes the draft.Fixes #2017