Release Guide

This guide assumes you have a clone of personal fork of async-backtrace, with two remotes:

1. origin, pointing at your personal fork
2. upstream, pointing at [email protected]:tokio-rs/async-backtrace.git

To release X.Y.Z, begin by preparing the release.

Preparing for Release

In a clone of your local fork:

1. run git pull upstream main --ff-only
2. tweak and run git checkout -b prepare-X.Y.Z
3. edit the entries in CHANGELOG.md under the ## [Unreleased] - ReleaseDate header (but do not change this header)
4. run git add CHANGELOG.md
5. tweak and run git commit -m 'prepare vX.Y.Z release'
6. tweak and run git push --set-upstream origin prepare-X.Y.Z
7. file a PR with the body text bors r+
8. wait for PR to merge

Releasing

Begin by creating a fresh clone of async-backtrace upstream for release:

git clone [email protected]:tokio-rs/async-backtrace.git async-backtrace-release

Run git log to verify that the last commit is the merge of the aforementioned PR.

Finally, run cargo release X.Y.Z --execute.