Skip to content

Commit c77a277

Browse files
authored
Add breaking-change category to release notes and release-check skill (#1619)
Add a "Breaking Changes" section to `.github/release.yml` so GitHub's auto-generated release notes include a dedicated category for PRs labeled `breaking-change`. Update the release-check skill to recognize the new label when auditing PRs and recommending version bumps.
1 parent 5214a30 commit c77a277

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

.claude/skills/release-check/SKILL.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,13 @@ Filter out the version-bump commit for the tag itself (e.g., "Bump version to v7
3838

3939
### 3. Identify release-relevant labels
4040

41-
Read `.github/release.yml` to find which labels map to changelog categories (currently `bug`, `enhancement`, `documentation`). PRs outside these categories appear under "Other Changes" and do not need labels.
41+
Read `.github/release.yml` to find which labels map to changelog categories (currently `breaking-change`, `bug`, `enhancement`, `documentation`). PRs outside these categories appear under "Other Changes" and do not need labels.
4242

4343
### 4. Report: PRs missing release-relevant labels
4444

4545
List PRs that look like they **should** have a release-relevant label but don't. Use the PR title and description to judge:
4646

47+
- PRs that remove public API or change default behavior in ways that break existing usage → likely needs `breaking-change` (note: dropping Ruby version support is not a breaking change, just a minor bump)
4748
- Titles starting with "Fix" or describing a fix → likely needs `bug`
4849
- Titles describing new features or capabilities → likely needs `enhancement`
4950
- Titles about docs → likely needs `documentation`
@@ -69,6 +70,9 @@ PRs that are clearly CI, dependency bumps, refactors, or test-only changes do **
6970
Show all PRs grouped by their release-relevant label, with URLs:
7071

7172
```
73+
### Breaking Changes
74+
- https://github.com/ruby/rdoc/pull/1616 — Remove deprecated CLI options and directives
75+
7276
### Enhancements
7377
- https://github.com/ruby/rdoc/pull/1544 — Highlight bash commands
7478
@@ -87,8 +91,10 @@ Show all PRs grouped by their release-relevant label, with URLs:
8791

8892
Apply semver reasoning:
8993

90-
- **Major** — breaking changes to public API or behavior users depend on
94+
- **Major** — breaking changes to public API or behavior users depend on (any PR with `breaking-change` label)
9195
- **Minor** — new features, significant internal rewrites that change behavior, enhancements
9296
- **Patch** — only bug fixes, documentation, and maintenance
9397

98+
If any PR has the `breaking-change` label, recommend a **major** version bump.
99+
94100
Explain the reasoning, highlighting the most impactful changes by URL.

.github/release.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
changelog:
44
categories:
5+
- title: 💥 Breaking Changes
6+
labels:
7+
- breaking-change
58
- title: ✨ Enhancements
69
labels:
710
- enhancement

0 commit comments

Comments
 (0)