docs: correct the release bump table — a breaking ! bumps the MAJOR#79
Merged
Conversation
The table claimed `feat` and a breaking `!` both bump the minor 'pre-1.0'. That is wrong for this repo: `bump-minor-pre-major` only applies below 1.0.0, and we are on 5.x, so a `!` bumps the MAJOR. Acting on the old wording is exactly how a `refactor(cloud)!:` PR title produced a 6.0.0-beta.1 release PR for a flag rename in an unconsumed beta. No Release-As footer: with the `!` removed from dev, release-please already computes 5.2.0-beta.2 on its own. Forcing it here would only risk that footer leaking into the production promotion.
161af8d to
1cd46fb
Compare
! bumps the MAJOR
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.
Correct the version release-please computed. PR #77 was squash-merged with a
refactor(cloud)!:title; the!marks a breaking change, and since this repo is on 5.x (post-1.0) that bumps the MAJOR — release-please duly openedchore(dev): release 6.0.0-beta.1(#78).bump-minor-pre-majordoes not save us: it only applies below 1.0.0.A major is wrong here. The change is a flag rename (--ios-config -> --ios-device-matrix) within the device-matrix feature, which exists only in 5.2.0-beta.1 — an unconsumed beta with no users to break. 5.2.0-beta.2 is what release-please would have computed from a plain
refactor:— the same 5.2.0 target, second beta iteration.Also fixes the CLAUDE.md bump table, which wrongly claimed a breaking
!bumps the minor "pre-1.0" and is what invited the mistake.Release-As: 5.2.0-beta.2
What & why
Type of change
fix— bug fixfeat— new featureperf— performance improvementrefactor— code change that's neither a fix nor a featuredocs— documentation onlychore/ci/build/test— tooling, no user-facing change!or PR notes aBREAKING CHANGE:)Checklist
pnpm lintpassespnpm typecheckpassespnpm buildpassesCHANGELOG.md(release-please handles this)README.md/STYLE_GUIDE.mdupdated if behaviour or output changedHow to test
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.