Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Releasing

The crate and its derive macro are published from this repository by GitHub Actions.

  1. Update version in Cargo.toml. If the derive macro changes, update its package version in afastorm-derive/Cargo.toml and the afastorm-derive dependency requirement in the main manifest.
  2. Update CHANGELOG.md and run the CI checks.
  3. Configure the repository Actions secret CARGO_REGISTRY_TOKEN with a crates.io publish token.
  4. Create and push a tag matching the v<version> pattern, such as v0.0.1.

The release workflow verifies the tag against the main crate version, publishes the derive dependency if that version is not already available, then publishes afastorm. The docs workflow builds the English afastorm book for GitHub Pages.

The minimum supported Rust version (MSRV) is 1.94, matching the SQLx 0.9 dependency. CI tests both Rust 1.94 and stable.

Do not reuse a published version. Crates.io releases are immutable; publish a new version for every change to either crate.

Applications that integrate afastorm through a Git/path dependency should switch to the published crates.io version after the release. The AFaster repository consumes afastorm by its published version and must update its lockfile after the first crate release.