docs: correct how release-please decides a version bump - #58
Merged
Merged
Conversation
The gotcha claimed release-please "counts only `feat` and breaking changes toward a bump". Any visible type that is not `feat` or breaking bumps a patch, and `release-type: python` makes `docs` visible where the shared default hides it, which is why docs-only commits open a release PR here. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011mJ5NaA5DdPxqa1Mb4UJhT
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.
What changed
The release-please gotcha in
AGENTS.mdsaid the tool "counts onlyfeatand breaking changes toward a bump". It doesn't. A second bullet now records thatdocs:cuts a patch release here on purpose, and names the commit types that stay quiet.Why
The claim was wrong in a way that made the current behaviour look like a misconfiguration. Any visible type that isn't
feator breaking bumps a patch, andrelease-type: pythonreplaces release-please's default changelog sections with google-cloud-python's, which makedocsanddepsvisible where the shared default hidesdocs. That is why PR #53 exists: onedocs(contrail-gh):commit opened a 0.5.2 release PR while threeci:commits and atest(ci):commit contributed nothing. Verified against release-please's source,src/strategies/python.ts:31and the empty-notes skip insrc/strategies/base.ts:331.The behaviour is left as it is. Hiding
docswould also drop documentation fromCHANGELOG.md, which isn't worth it here.Checks
./venv/bin/ruff check .and./venv/bin/ruff format .pass./venv/bin/pytest -qpassesgh issue listfor open issues this change touchesNo config option, importer, emissions provider or behaviour changed, so the middle two are inapplicable. None of the six open issues touch this.
Test plan
./venv/bin/pytest -q: 326 passed./venv/bin/ruff check .: clean;ruff format --check .: 54 files already formatted./venv/bin/pre-commit run --files AGENTS.md: markdownlint-cli2 and mdformat both pass, so the wrapping is what mdformat would writemain, not from memory🤖 Generated with Claude Code
https://claude.ai/code/session_011mJ5NaA5DdPxqa1Mb4UJhT