chore(release): add Build & Tooling category and create the missing release-note labels - #82
Open
SomethingNew71 wants to merge 1 commit into
Open
chore(release): add Build & Tooling category and create the missing release-note labels#82SomethingNew71 wants to merge 1 commit into
SomethingNew71 wants to merge 1 commit into
Conversation
…abels The v2.12.1 notes filed a security and dependency release under "Other Changes". The cause was not a missing category — 🔒 Security and 📦 Dependencies were already configured — but that GitHub categorises release notes by the pull request's labels only, and 21 of the labels this config referenced had never been created in the repo. An unlabelled PR falls through the "*" catch-all, so most of these categories could never match anything. All 21 missing labels now exist (security, fix, maintenance, parser, ui, docs, test, deps and the rest), plus build/ci/tooling for the new category. Added a header comment recording that labels are the mechanism, since the failure mode is silent — the notes generate successfully, just in the wrong bucket. New 🏗️ Build & Tooling category covers edition migrations, toolchain moves and release-workflow changes, which previously had to land in Maintenance or fall through to Other. This release had a Rust edition 2024 migration and four GitHub Actions major bumps with nowhere to go.
There was a problem hiding this comment.
Pull request overview
Updates GitHub’s release-notes configuration to correctly bucket changes based on pull request labels, preventing unlabelled PRs from silently falling into the "*" catch-all.
Changes:
- Adds an explanatory header comment documenting that GitHub release notes categorization is label-driven.
- Introduces a new “🏗️ Build & Tooling” category keyed off
build,ci, andtoolinglabels.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Follow-up to #81, where a security and dependency release was filed under "🔄 Other Changes".
The actual cause
Not a missing category — 🔒 Security and 📦 Dependencies were already configured. GitHub's
generated release notes categorise by the pull request's labels only; they never look at commit
messages or PR titles. PR #81 carried no labels, so it fell through the
"*"catch-all.Worse, 21 of the labels this config referenced had never been created in the repo — including
security,maintenance,parser,ui,docs,testanddeps. Most categories here couldtherefore never match anything, and the failure is silent: notes still generate, just in the wrong
bucket.
All 21 now exist, plus
build/ci/toolingfor the new category (created directly, no codechange needed). A header comment on the file records that labels are the mechanism, so the next
person does not re-diagnose this.
New category
🏗️ Build & Tooling — edition migrations, toolchain moves, and release-workflow changes.
Previously these had to be filed under Maintenance or fall through to Other. v2.12.1 alone had a
Rust edition 2024 migration and four GitHub Actions major bumps with nowhere to go.
Verified
release.ymlparses cleanly (12 categories), and every label referenced by the config — includingthe two
excludeentries — now resolves to a real label in the repo.PR #81 has been labelled retroactively (
security,dependencies,bug,build) so thehistorical record and the
v2.12.0...v2.12.1compare view are correct.