crates.io releases are automated via GitHub actions and triggered by pushing a tag.
-
Record a new demo gif if necessary. The preferred tool for this is vhs (installation instructions in README).
cargo build --example demo vhs examples/demo.tape --publish --quiet
Then update the link in the examples README and the main README. Avoid adding the gif to the git repo as binary files tend to bloat repositories.
-
Bump the version in Cargo.toml.
-
Bump versions in the doc comments of lib.rs.
-
Ensure CHANGELOG.md is updated. git-cliff can be used for generating the entries.
-
Commit and push the changes.
-
Create a new tag:
git tag -a v[X.Y.Z] -
Push the tag:
git push --tags -
Wait for Continuous Deployment workflow to finish.