Skip to content

Latest commit

 

History

History
12 lines (10 loc) · 788 Bytes

RELEASE.md

File metadata and controls

12 lines (10 loc) · 788 Bytes

Creating a Release

GitHub and crates.io releases are automated via GitHub actions and triggered by pushing a tag.

  1. Bump the version in Cargo.toml according to Semantic Versioning.
  2. Update Cargo.lock by building the project: cargo build
  3. Update CHANGELOG.md by running git-cliff: git cliff -u -t v[X.Y.Z] -p CHANGELOG.md
  4. Commit your changes: git add -A && git commit -m "chore(release): bump version"
  5. Pull existing tags: git fetch --tags
  6. Create a new tag: git tag v[X.Y.Z]
  7. Push the tag: git push --tags
  8. Announce the release! 🥳