build.yaml

name: Build

on:
  push:
    branches:
      - main
  pull_request:
  workflow_dispatch:

# Cancel previously running PR jobs
concurrency:
  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
  cancel-in-progress: true

jobs:
  build_and_test:
    name: Build & Test
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/${{ github.repository }}-rust-ci:latest
    steps:
      - uses: actions/checkout@v4
      - uses: Swatinem/rust-cache@v2
        with: { sharedKey: fullBuild }
      - run: cargo check --workspace --all-targets
      - run: cargo build --workspace --all-targets
      - run: cargo test --workspace --all-targets

  # Ensure documentation builds and links are valid.
  doc:
    name: Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: hecrj/setup-rust-action@v1
      - uses: Swatinem/rust-cache@v2
        with: { sharedKey: fullBuild }
      - run: cargo doc --all-features --no-deps
        env: { RUSTDOCFLAGS: -Dwarnings }

  # Ensure clippy doesn't complain.
  clippy:
    name: Clippy
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/${{ github.repository }}-rust-ci:latest
    steps:
      - uses: actions/checkout@v4
      - uses: Swatinem/rust-cache@v2
      - run: cargo clippy --all-targets --workspace -- -D warnings

  # Ensure fmt doesn't complain.
  fmt:
    name: Format
    runs-on: ubuntu-latest
    container:
      image: ghcr.io/${{ github.repository }}-rust-ci:latest
    steps:
      - uses: actions/checkout@v4
      - uses: hecrj/setup-rust-action@v1
        with:
          components: rustfmt
      - run: cargo fmt --all -- --check