Section the auto-generated release notes by label - #7166
Open
albertvillanova wants to merge 1 commit into
Open
Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
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.
This PR adds
.github/release.ymlso the release notes GitHub drafts come out already split into sections, instead of one flat list.Motivation
Every release so far has been written by hand on top of a flat "What's Changed" list, and the resulting notes have used the same sections since v1.9: Breaking, Features, Fixes, Documentation, CI. GitHub can produce that split itself from a label to section mapping.
Solution
The section titles match the ones the recent releases already use, so the draft lands shaped like the final notes and the remaining work is promoting entries into hand-written subsections rather than sorting them.
Three of the labels already exist (
✨ enhancement,🐛 bug,📚 documentation), and Dependabot already appliesdependenciesto all of its PRs, so that section works with no extra effort. Two labels do not exist yet and are listed below as a blocker.An unlabelled PR falls into
Other, which is what the flat list gives today, so nothing regresses while labelling ramps up.Priority labels such as
🩹 for patchare deliberately left out: they mark a different axis, and since a PR lands in the first matching category they would pull PRs out of the section that describes what actually changed.Changes
.github/release.ymlmapping labels to release notes sectionsOtheris the catch-all and stays last, since a PR lands in the first category whose labels matchBefore merging
💥 breakinglabel: breaking change, removal, or deprecation🔧 maintenancelabel: CI, tooling, tests, or repo upkeepNote
Low Risk
Adds GitHub release-notes configuration only; no runtime or application code changes.
Overview
Adds
.github/release.ymlso GitHub’s auto-generated release notes draft is grouped into sections (Breaking, Features, Fixes, Documentation, CI and maintenance, Dependencies, Other) instead of a single flat list.Each section maps to existing or planned PR labels (e.g.
✨ enhancement,🐛 bug,dependencies); unlabeled PRs land in Other via the catch-all*label, which must remain last because GitHub assigns each PR to the first matching category.Reviewed by Cursor Bugbot for commit b95db9a. Bugbot is set up for automated code reviews on this repo. Configure here.