Add kind/breaking label for breaking changes in release notes - #79
Merged
Conversation
Breaking changes are currently invisible in the generated release notes: they land in Features or Refactors like any other PR. Add a dedicated kind/breaking label and a "Breaking Changes" section. - release.yml: the section is listed FIRST, so a PR that is both a feature and a breaking change surfaces as breaking. GitHub's release-notes config is static and cannot key off the version being cut, but the section is self-gating: it only renders when a PR in the range carries the label. - labels.sh: kind/breaking in red (b60205) rather than the kind/* blue, so it stands out on the PR list. The older unnamespaced "breaking change" label is left untouched. - pull_request_template.md: note that a breaking change belongs in a major release and that the PR summary should describe the upgrade path. Labels are not synced automatically — run .github/labels.sh after merge.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #79 +/- ##
=======================================
Coverage 94.52% 94.52%
=======================================
Files 33 33
Lines 731 731
Branches 71 71
=======================================
Hits 691 691
Misses 31 31
Partials 9 9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Summary
Breaking changes are currently invisible in the generated release notes — they land in 🚀 Features or ♻️ Refactors like any other PR. This adds a dedicated⚠️ Breaking Changes section.
kind/breakinglabel and a.github/release.yml— the section is listed first. Since a PR lands in only the first matching category, a PR that is both a feature and a breaking change is listed as breaking rather than under Features. That is intentional: it is the section people read when upgrading..github/labels.sh—kind/breakingin red (b60205) instead of thekind/*blue, so it stands out on the PR list..github/pull_request_template.md— a checklist item noting that a breaking change belongs in a major release and that the PR summary should describe the upgrade path, since it ends up in the release notes.Notes
GitHub's release-notes config is static and cannot key off the version being cut, so "only for major releases" is not directly expressible. The section is self-gating instead: it only renders when a PR in the release range actually carries the label.
.github/labeler.ymlis deliberately untouched — breaking-ness cannot be derived from file paths, so it stays a human call likekind/featurevskind/bug. Therequire-release-labelcheck already accepts anykind/*prefix, so no workflow change was needed.The label has already been created in this repo via
.github/labels.sh. The same change is going out toorchestrator-core,nwa-stdlib,oauth2-libandpydantic-formsso the four repos stay consistent.Type of change
kind/*label describing the change —kind/ci, applied automatically from the changed paths.kind/breaking. — n/aChecklist
🤖 Generated with Claude Code