RELEASE.adoc

Release Process

This project uses cargo-dist and cargo-release to simplify cutting new releases.

Update the Changelog

vim CHANGELOG.md
git add CHANGELOG
git commit
git push

Create a Release

Reference: Using cargo-release with Pull Requests

1. Create a release branch

   git checkout -b $BRANCH

2. Update CHANGELOG

   vim CHANGELOG.md
   git add -p
   git commit

3. Update version in Cargo.toml, add, commit, and push

   cargo release --no-publish --no-tag --allow-branch $BRANCH $VERSION

   E.g.,

   cargo release --no-public --no-tag --allow-branch r1.0.1 1.0.1

4. Open a PR, review, and merge to main

5. Pull main, dist plan

   git checkout main
   git pull
   dist plan

6. Tag, push tag, trigger dist

   cargo release

Sit Back and Relax

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