name: CI
on:
push:
branches: [ main, master ]
tags: [ 'v*' ]
pull_request:
branches: [ main, master ]
workflow_dispatch:
env:
CARGO_TERM_COLOR: always
RUSTFLAGS: "-Dwarnings"
jobs:
test:
name: Test Suite
runs-on: ubuntu-latest
strategy:
matrix:
toolchain: [stable, beta]
steps:
- uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.toolchain }}
- name: Cache dependencies
uses: Swatinem/rust-cache@v2
- name: Run tests
run: cargo test --all-features --verbose
lint:
name: Lint & Format
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install stable toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: clippy, rustfmt
- name: Cache dependencies
uses: Swatinem/rust-cache@v2
- name: Check formatting
run: cargo fmt -- --check
- name: Run clippy
run: cargo clippy --all-features -- -D warnings
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install stable toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cache dependencies
uses: Swatinem/rust-cache@v2
- name: Check documentation
run: cargo doc --no-deps --all-features --document-private-items
env:
RUSTDOCFLAGS: "-D warnings"
deploy:
name: Deploy to Crates.io
runs-on: ubuntu-latest
needs: [test, lint, docs]
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
steps:
- uses: actions/checkout@v4
- name: Install stable toolchain
uses: dtolnay/rust-toolchain@stable
- name: Get crate info
id: crate_info
run: |
CRATE_NAME=$(cargo metadata --no-deps --format-version 1 | jq -r '.packages[0].name')
CRATE_VERSION=$(cargo metadata --no-deps --format-version 1 | jq -r '.packages[0].version')
echo "name=$CRATE_NAME" >> $GITHUB_OUTPUT
echo "version=$CRATE_VERSION" >> $GITHUB_OUTPUT
- name: Check if version already published
id: check_published
run: |
if cargo search ${{ steps.crate_info.outputs.name }} | grep -q "^${{ steps.crate_info.outputs.name }} = \"${{ steps.crate_info.outputs.version }}\""; then
echo "published=true" >> $GITHUB_OUTPUT
echo "Version ${{ steps.crate_info.outputs.version }} is already published"
else
echo "published=false" >> $GITHUB_OUTPUT
echo "Version ${{ steps.crate_info.outputs.version }} is not yet published"
fi
- name: Publish to Crates.io
if: steps.check_published.outputs.published == 'false'
run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}