Skip to content

RELEASING.md

Latest commit

 

History

History
54 lines (43 loc) · 1.8 KB

RELEASING.md

File metadata and controls

54 lines (43 loc) · 1.8 KB

Releasing

Prerequisites

  • CARGO_REGISTRY_TOKEN org secret configured at github.com/UOR-Foundation (Settings > Secrets and variables > Actions)

Release Process

  1. Update version in the workspace root Cargo.toml:

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

  2. Regenerate the foundation crate and commit:

    cargo run --bin uor-crate
cargo fmt -- foundation/src/**/*.rs foundation/src/*.rs
git add Cargo.toml Cargo.lock foundation/src/
git commit -m "Bump version to X.Y.Z"

  3. Tag and push:

    git tag vX.Y.Z
git push origin main --tags

  4. The release workflow will automatically:

    • Validate the tag matches the uor-foundation Cargo.toml version
    • Run all checks (fmt, clippy, test, conformance)
    • Regenerate the foundation crate and verify no drift
    • Verify crate packaging with cargo publish --dry-run
    • Create a GitHub Release with ontology artifacts
    • Publish uor-foundation to crates.io

Published Crate

The published crate is uor-foundation (generated from foundation/). The internal ontology crate uor-ontology (in spec/) is not published.

Troubleshooting

  • Tag/version mismatch: The workflow fails early if the tag version does not match Cargo.toml. Fix the version and re-tag.
  • Generated code drift: If git diff --exit-code foundation/src/ fails in CI, the committed generated code doesn't match the generator output. Run cargo run --bin uor-crate && cargo fmt locally and commit.
  • crates.io publish failure: The GitHub Release will already exist. Fix the issue, delete and re-create the tag, or manually run cargo publish -p uor-foundation.
  • Version already published: crates.io does not allow re-publishing the same version. Bump the version and create a new tag.