Repository navigation
Cut releases with commitizen instead of by hand - #11
Merged
Merged
Conversation
The version is mirrored in five files and the bump was manual, so a merge could land a feature without moving it. `cz bump` reads the Conventional Commits since the last tag, works out the increment, rewrites all five and tags. It runs through uvx, so it is not a dependency of anything. The CHANGELOG stays hand-written: the entries here explain what changed and why, which a list of commit subjects does not. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <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
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.
TLDR: The version is mirrored in five files and the bump was manual, so a merge could land a feature without moving it.
cz bumpnow reads the Conventional Commits since the last tag, works out the increment, rewrites all five and tags.uvx --from commitizen cz bump --yes && git push --follow-tags.cz.toml— the five mirrors (SKILL.md, bothplugin.json,marketplace.json, the README badge),tag_format = "v$version", andbump_message = "chore(release): $new_version"so release commits keep the shape this repo's history already uses. commitizen's defaultbump:is not one of the typesCONTRIBUTING.mdallows.uvx, so nothing is installed and no manifest mentions it. The stdlib-only rule covers the scripts that ship to users; a tool the maintainer runs at release time is a different thing, and the config says so.update_changelog_on_bump = false). The entries here are prose explaining what changed and why; the generated form is a list of commit subjects.cz changelog --dry-runstill prints them grouped by type, which is a useful checklist to write the section from.AGENTS.md— new, because the repo had none. Leads with the release step, since that is the thing that was being missed, and adds the handful of conventions that are easy to get wrong from the outside: stdlib-only,--selftestinstead of a test suite, Conventional Commits (which the release tooling now reads), the note-as-database contract, and that colour and type come fromthemes.py.CONTRIBUTING.mdgains a Releases section with the command and the rationale.Verified in a throwaway clone:
feat→ minor,fix→ patch,feat!→ major; all five files rewritten;chore(release): X.Y.Zcommitted andvX.Y.Ztagged; the CHANGELOG untouched.Needs one bootstrap step after merge:
git tag v1.3.0 <main>and push it, so commitizen has a baseline to count from. The repo only hasv1.0.0today.