-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: further simplify the release process
- Loading branch information
1 parent
b93436a
commit 3a15984
Showing
1 changed file
with
12 additions
and
19 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <version> | ||
|
||
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. |