fix: keep breaking changes inside 0.x instead of releasing 1.0.0 - #15
Open
NickJosevski wants to merge 2 commits into
Open
fix: keep breaking changes inside 0.x instead of releasing 1.0.0#15NickJosevski wants to merge 2 commits into
NickJosevski wants to merge 2 commits into
Conversation
release-please opened #13 proposing 1.0.0, because bump-minor-pre-major defaults to false and a breaking change therefore takes 0.x straight to 1.0.0. We want to keep iterating on 0.x, so set it to true: pre-1.0.0 breaking changes now produce a minor bump, making the octo -> octopus migration 0.2.0 rather than 1.0.0. Also corrects the version numbers the migration docs promise, which were written assuming a 1.0.0 release: "changed in v1" -> "changed in 0.2.0", and "Migrating from v0.x" -> "Migrating from 0.1.x" with its anchor. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Why
release-please opened #13 proposing 1.0.0. That's because
bump-minor-pre-majordefaults tofalse, so afeat!:on a 0.x version jumps straight to 1.0.0. We want to keep iterating on 0.x.The change
release-type: simple + bump-minor-pre-major: trueon both invocations. Pre-1.0.0 breaking changes now produce a minor bump, so the
octo→octopusmigration becomes 0.2.0 rather than 1.0.0. The existing tag-maintenance step keeps working and will producev0andv0.2, consistent with the currentv0.1tag.Also fixes docs that promised the wrong version
The migration notes merged in #9 were written assuming a 1.0.0 release, so they now say the wrong thing:
(changed in v1)→(changed in 0.2.0)— inhooks/command,plugin.yml, and the README inputs table## Migrating from v0.x→## Migrating from 0.1.x, plus the in-page anchor and the two prose referencesLeft alone deliberately:
octopus-login#v1.0.0in the README is the login plugin's version, andStepA:Acme.Web:1.0.0is example package data.What happens to #13
release-please recomputes on every run, so once this is on
mainit should update #13 fromchore(main): release 1.0.0torelease 0.2.0. Worth confirming rather than assuming — if it doesn't refresh, closing #13 will make release-please open a fresh one.bump-minor-pre-majoris an action input in v3 but was removed as an input in v4 ("remove most configuration options in favor of manifest configuration"). In the v5 that #11 moves to, it only exists as$.bump-minor-pre-majorinside arelease-please-config.json.So if #11 merges as it currently stands, this input becomes silently inert and the next breaking change goes to 1.0.0 again. I'll add the config-file equivalent to #11 so the behaviour carries over — flagging it here so it isn't lost if the PRs are reviewed by different people.
Merge order that avoids surprises: this PR → #11 (with the config file) → #13.
Verification
16 tests, linter (7 examples valid) and shellcheck all pass.
🤖 Generated with Claude Code