chore: keep release-please pre-1.0 (breaking changes bump minor, not major)#199
Merged
Conversation
…major) cachekit is still alpha (Development Status :: 3 - Alpha, version 0.x). Without bump-minor-pre-major, release-please escalates any BREAKING CHANGE straight to 1.0.0 — which is why the orjson optional-dependency change (#196) produced a "release 1.0.0" PR (#198). Set bump-minor-pre-major so that while the version is below 1.0.0, breaking changes bump the minor (0.10.1 -> 0.11.0) instead of the major. Once this lands on main, release-please recomputes the pending release PR to 0.11.0.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
Walkthrough
ChangesRelease Please Configuration Update
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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.
Why
cachekit is still alpha (
Development Status :: 3 - Alpha, version0.x). release-please's default treats aBREAKING CHANGEas a major bump even below 1.0.0 — so the orjson optional-dependency change (#196, which carried aBREAKING CHANGE:footer for the install-contract change) made release-please open #198 "release 1.0.0". We don't want to ship 1.0.0 yet.Fix
Set
bump-minor-pre-major: trueon the package. While the version is below 1.0.0, breaking changes now bump the minor (0.10.1 → 0.11.0) instead of jumping to1.0.0. The breaking change is still surfaced in the changelog — it just doesn't escalate the major version prematurely.Once this lands on
main, release-please recomputes the pending release PR (#198) from1.0.0to0.11.0.Notes
bump-patch-for-minor-pre-major: truewould also make plainfeat:commits bump patch (not minor) while pre-1.0 — an even more conservative alpha cadence. Left out so this PR only addresses the 1.0.0 escalation; easy to add if you want features to stay patch-level too.BREAKING CHANGE:footer on the orjson commit was over-ceremony for an alpha project. The merged commit can't be cleanly reworded, but this config makes its (and any future) breaking change resolve to a sane pre-1.0 version.Summary by CodeRabbit
Release Notes