how_to_release.md

To create a release

The releases are automated via GitHub actions, using this configuration file.

The release is triggered by pushing a tag.

1. Bump the version in Cargo.toml
2. Update the "Unreleased" header for the new version in the CHANGELOG
3. Create a new tag e.g. git tag -a v0.7.0
4. Push the tag git push --tags
5. Wait for the build to finish on the Actions page
6. Download the sha file, copy the sha into the tap repo formula and bump the version there too
7. Push to the tap repo with the new sha and version

Local

This step is not yet automated

1. cargo publish --dry-run to check everything is good
2. cargo publish