Repository navigation
Derive the release bump from a per-item breaking flag - #918
Merged
Merged
Conversation
Prepare release no longer takes a bump input. Each release-note item may carry a boolean breaking flag; any flagged item makes the release major, otherwise it is minor. The render script writes the [Breaking] prefix from the flag, sorts flagged items first, and rejects a message that already starts with the prefix. The release guide and wizard follow.
🤖 GitHub commentsJust comment with:
|
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Documentation should accurately describe the renderer’s start-of-message prefix validation.
Get a fresh assessment by requesting another Copilot review.
Review effort: Lite
Findings: 2
Open (2)
What changed in this PR
This PR derives release bumps from per-item breaking flags instead of a workflow-level input.
Changes:
- Removes the manual bump input.
- Validates, sorts, and renders breaking release notes.
- Updates release scripts, documentation, wizard guidance, and sample data.
| File | Summary |
|---|---|
skills/android-release-wizard/SKILL.md |
Updates wizard guidance for breaking flags. |
RELEASING.md |
Documents flag-based release versioning. |
.github/workflows/prepare-release.yml |
Removes the bump input. |
.github/scripts/release/sample.json |
Demonstrates breaking-note metadata. |
.github/scripts/release/render-release-notes.sh |
Validates, sorts, and renders release notes. |
.github/scripts/release/prepare-release.sh |
Derives the release bump from note flags. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The guide and wizard described the check as rejecting any occurrence of [Breaking] in a message. The render script rejects only a message that starts with it, which is the intended rule.
LikeTheSalad
marked this pull request as ready for review
September 24, 2026 14:54
trentm
approved these changes
Sep 24, 2026
v1v
approved these changes
Sep 24, 2026
Merged
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.
These changes remove the
bumpinput from the prepare release workflow. This makes the workflow simpler and will also help with a follow-up "patch release" support path.This
bumpinput was mostly to help prepare a major release, as by default it was always "minor", but since major releases aren't that common, and they also depend on there being a breaking change, the major version bump can be signaled by a breaking change in the release notes instead. This makes the overall process less error-prone in case someone accidentally chooses the "major" version bump input option when a minor release was due.Each release-note item may carry a boolean breaking flag, and any flagged item makes the release major, otherwise it is minor. The render script writes the [Breaking] prefix from the flag, sorts flagged items first, and rejects a message that already starts with the prefix. The release guide and wizard are also updated.