RELEASING.md

Releasing

1. Create a release branch:

   git checkout main
   git pull
   git checkout -b release/vX.Y.Z

2. Update the version in Cargo.toml under [workspace.package]:

   [workspace.package]
   version = "X.Y.Z"

3. Regenerate the lockfile:

   cargo generate-lockfile

4. Commit and push the version bump:

   git add Cargo.toml Cargo.lock
   git commit -m "Release vX.Y.Z"
   git push -u origin release/vX.Y.Z

5. Open a pull request into main and get it merged.

6. Tag the release from main:

   git checkout main
   git pull
   git tag vX.Y.Z
   git push origin vX.Y.Z

   The tag must match the pattern vX.Y.Z and the version in Cargo.toml.

7. Monitor the release. The Release workflow will automatically verify the tag matches the crate version and publish to crates.io.

   You can follow progress in the Actions tab of the repository.