Skip to content

Commit

Permalink
doc: expand release doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rfdonnelly committed Aug 15, 2024
1 parent dff7f39 commit 34ce297
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion RELEASE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,35 @@ This project uses https://opensource.axo.dev/cargo-dist/[cargo-dist] and https:/
git commit
git push

== Create a Release
== Dryrun the Release

cargo dist build
cargo dist plan
cargo release <version>

E.g.

cargo release 1.0.1

== Execute the Release

cargo release <version> --execute

E.g.

cargo release 1.0.1 --execute

This will:

* Update version in `Cargo.toml` and `Cargo.lock` and commit them
* Publish the release to crates.io
* Creates a tag and pushes it

Pushing the tag then kicks off cargo-dist which:

* Builds release artifacts
* Creates a GitHub Release

== Sit Back and Relax

Sit back and relax while `cargo-dist` automatically creates a GitHub Release and releases binaries for each platform.
Expand Down

0 comments on commit 34ce297

Please sign in to comment.