name: Release Readiness
concurrency:
group: release-${{ github.ref }}
cancel-in-progress: false
on:
workflow_dispatch:
inputs:
version:
description: Expected crate version from Cargo.toml
required: true
type: string
push:
tags:
- "v*"
- "*.*.*"
permissions:
contents: read
env:
CARGO_TERM_COLOR: always
jobs:
release-readiness:
runs-on: ubuntu-latest
outputs:
release_version: ${{ steps.resolve-release-version.outputs.release_version }}
steps:
- uses: actions/checkout@v4
- name: Resolve release version
id: resolve-release-version
env:
INPUT_VERSION: ${{ github.event.inputs.version }}
run: |
if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
release_version="${GITHUB_REF_NAME#v}"
else
release_version="${INPUT_VERSION}"
fi
if [[ -z "${release_version}" ]]; then
echo "failed to resolve release version"
exit 1
fi
echo "release_version=${release_version}" >> "${GITHUB_OUTPUT}"
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
components: rustfmt, clippy
- uses: Swatinem/rust-cache@v2
- uses: taiki-e/install-action@v2
with:
tool: cargo-deny
- uses: taiki-e/install-action@v2
with:
tool: cargo-public-api
- name: Install nightly for docs.rs check
run: rustup toolchain install nightly --profile minimal
- name: Verify release metadata
env:
RELEASE_VERSION: ${{ steps.resolve-release-version.outputs.release_version }}
run: bash ./scripts/check-release.sh
- name: Format
run: cargo fmt --all -- --check
- name: Generated Endpoint Catalog
run: python3 ./scripts/generate_endpoints.py --check
- name: Cargo Deny
run: cargo deny check
- name: Public API
run: bash ./scripts/check-public-api.sh
- name: No Default Features
run: cargo test --no-default-features
- name: All Features
run: cargo test --all-features
- name: Examples
run: cargo check --examples --all-features
- name: Ecosystem Fixtures
run: bash ./scripts/check-ecosystem.sh
- name: Downstream Canaries
run: bash ./scripts/check-downstream-canaries.sh
- name: Clippy
run: cargo clippy --all-targets --all-features -- -D warnings
- name: Cargo publish dry run
run: cargo publish --dry-run --all-features
- name: Docs.rs-style docs build
env:
RUSTDOCFLAGS: --cfg docsrs
run: cargo +nightly doc --all-features --no-deps
publish-crate:
name: Publish Crate
needs: release-readiness
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@master
with:
toolchain: stable
- uses: Swatinem/rust-cache@v2
- name: Verify crates.io token is configured
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
run: |
if [[ -z "${CARGO_REGISTRY_TOKEN}" ]]; then
echo "CARGO_REGISTRY_TOKEN secret is not configured"
exit 1
fi
- name: Verify tag matches Cargo.toml
env:
RELEASE_VERSION: ${{ needs.release-readiness.outputs.release_version }}
run: bash ./scripts/check-release.sh
- name: Publish to crates.io
env:
CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
run: cargo publish --all-features --registry crates-io