Releases are automated with release-plz.
There is no manual version bump, no hand-edited changelog release section, and no manual git tag.
-
Land your changes on
main. Use Conventional Commits for commit and PR titles, and record user-visible changes under## [Unreleased]in CHANGELOG.md. -
release-plz opens a release PR. Every push to
mainruns therelease-plz-prjob in.github/workflows/release-plz.yml. It opens (or updates) a release PR that bumps the version in[workspace.package], updates the inter-crate dependency requirements, and moves theUnreleasedchangelog entries under the new version heading. Review it like any other PR; if the generated changelog needs editing, push to that branch. -
Merge the release PR. The resulting push to
mainruns therelease-plz-releasejob, which:- publishes
cql2andcql2-clito crates.io (cql2-pythonandcql2-wasmarepublish = false), - creates the tags
cql2-vX.Y.Zandcql2-cli-vX.Y.Z, - creates the matching GitHub releases.
- publishes
-
The
cql2-vX.Y.Ztag fans out to the other publishers.
- Do not create tags by hand. All three tag-triggered workflows match
cql2-v*. A hand-cutvX.Y.Ztag matches none of them, and tagging manually alongside release-plz produces a split release where some artifacts ship and others do not. - All four packages share a single version, defined once in
[workspace.package]in the rootCargo.toml. - Each of the three workflows above also accepts
workflow_dispatchfor re-runs.pypi.ymlandnpm.ymlonly publish when the dispatch targets a tag ref;docs.ymlwill deploy the most recentcql2-v*tag.