ci: automate releases with release-plz#13
Merged
Merged
Conversation
Replace the local cargo-release flow (release.toml, just release recipes) with release-plz running in CI, mirroring the setup proven in rust-ontogen and rust-path-opener: a bot opens a 'chore: release' PR on pushes to main; merging it tags, publishes to crates.io, and creates a GitHub Release. Changelog generation stays on the existing cliff.toml. README documents the two one-time steps each templated repo needs: the CARGO_REGISTRY_TOKEN secret and enabling 'Allow GitHub Actions to create and approve pull requests'. RELEASE.md covers the full flow, the tracked-and-gitignored gotcha, and the manual escape hatch.
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.
Replaces the local cargo-release flow with release-plz running in CI — the setup proven in rust-ontogen and just rolled out to rust-path-opener (sksizer/rust-path-opener#16). New repos created from this template get automated releases out of the box.
What changes
release-plz.toml— publish to crates.io on release-PR merge, GitHub Release per release,cargo-semver-checksgate, changelog via the existingcliff.toml. Includes a documentedpublish = falseescape for non-published projects..github/workflows/release-plz.yml— runs the release-plz action on every push tomain.release.tomlremoved — cargo-release is retired; one release path only.justfile—release/release-dry-runrecipes dropped;changelogandsemver-checkkept as local previews.README.md— new Automated Releases section documenting the two one-time steps per templated repo: setting theCARGO_REGISTRY_TOKENsecret and enabling Allow GitHub Actions to create and approve pull requests (withghone-liners for both).RELEASE.md— the full flow, versioning rules, the tracked-and-gitignored gotcha, and the manual escape hatch.Flow in templated repos
Push to
main→ bot opens/updates achore: releasePR (version bump + changelog) → merging that PR tagsv{version}, publishes to crates.io, and creates a GitHub Release.