ci: automate releases with release-plz - #51
Merged
Merged
Conversation
Replace the manual tag-triggered release-cargo.yml with release-plz. On push to main it keeps a release PR open that bumps oxia-client's version from the conventional commits since the last release; merging that PR publishes to crates.io, tags vX.Y.Z, and creates a GitHub Release with notes generated from the commit history. Configured for this repo's conventions (release-plz.toml): no in-repo CHANGELOG (changelog_update = false — notes live in the GitHub Release), only oxia-client is released (the FFI shim and perf tool are internal), and release-plz's semver check is off since ci.yml already runs cargo-semver-checks. RELEASING.md documents the flow and one-time setup. Signed-off-by: Matteo Merli <mmerli@apache.org>
…nternal crates Signed-off-by: Matteo Merli <mmerli@apache.org>
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.
What (roadmap P5-7)
Automates releases with release-plz, replacing the manual
release-cargo.yml(removed).On every push to
main, the newRelease-plzworkflow:oxia-client's version from the Conventional Commits merged since the last release;cargo publishesoxia-client, pushes avX.Y.Ztag, and creates a GitHub Release with notes generated from the commit history.Fits this repo's conventions (
release-plz.toml)changelog_update = false, so noCHANGELOG.mdis ever written; release notes live in the GitHub Release (matching the earlier decision).oxia-clientis released — the FFI shim andoxia-perfare internal (publish = false+release = false); release-plz never publishes/tags them (it may bump the FFI version in lockstep).semver_check = false—ci.ymlalready runscargo-semver-checksagainst the published baseline; not duplicated here.Verification
Ran
release-plz updateagainst the repo (in a plain clone) — it loaded the config and computedoxia-client: 0.1.0 → 0.1.1and wrote noCHANGELOG.md(onlyCargo.toml/Cargo.lockversion bumps). Config TOML + workflow YAML validated. The full publish/GitHub-Release path only runs on GitHub, so the first release is the end-to-end confirmation.Documented in RELEASING.md:
CRATE_TOKENsecret (already set for 0.1.0) is reused asCARGO_REGISTRY_TOKEN— needs publish-update scope foroxia-client.release-prjob'sGITHUB_TOKEN(PRs opened by the defaultGITHUB_TOKENdon't trigger other workflows).