From 3a15984880c07f5d1da4c47c4dfaade3d6693b38 Mon Sep 17 00:00:00 2001 From: Rob Donnelly Date: Tue, 1 Aug 2023 17:43:40 -0700 Subject: [PATCH] doc: further simplify the release process --- RELEASE.adoc | 31 ++++++++++++------------------- 1 file changed, 12 insertions(+), 19 deletions(-) diff --git a/RELEASE.adoc b/RELEASE.adoc index 5e1a928..80c8f5f 100644 --- a/RELEASE.adoc +++ b/RELEASE.adoc @@ -1,29 +1,22 @@ = Release Process -This project uses https://opensource.axo.dev/cargo-dist/[cargo-dist]. -Creating a release is as simple as creating and pushing a release tag. +This project uses https://opensource.axo.dev/cargo-dist/[cargo-dist] and https://github.com/crate-ci/cargo-release[cargo-release] to simplify cutting new releases. -== Define Version +== Update the Changelog - version=x.y.z - -== Set Version - -NOTE: This requires `cargo-edit`. - - cargo set-version $version - -== Commit and Push - - git add Cargo.toml Cargo.lock + vim CHANGELOG.md + git add CHANGELOG git commit git push -== Tag and Push +== Create a Release + + cargo release + +E.g. - git tag v$version - git push origin v$version + cargo release 1.0.1 -== Relax +== Sit Back and Relax -Sit back a relax while `cargo-dist` automatically creates a GitHub Release and releaes binaries for each platform. +Sit back and relax while `cargo-dist` automatically creates a GitHub Release and releases binaries for each platform.