ci.yml

name: CI

on:
  # TODO re-enable once project is set up properly
  # push:
  #   branches:
  #     - main
  # pull_request:
  workflow_dispatch:

env:
  CARGO_TERM_COLOR: always
  CI: 1

jobs:
  clippy:
    name: Clippy validation
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust with clippy
        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
        with:
          toolchain: stable
          components: clippy
          cache: false

      - name: Rust Cache
        # Temporary fork of `Swatinem/rust-cache` with support for caching `cargo binstall`ed binaries
        # Should be switched if this feature is merged in the main action: https://github.com/Swatinem/rust-cache/pull/325
        uses: clechasseur/rust-cache@45dfca100f1e255035d993b3dc7a8c356de54bf8
        with:
          prefix-key: v1.0.0-rust
          cache-on-failure: true

      - name: Setup cargo-binstall
        uses: cargo-bins/cargo-binstall@v1.17.9
        with:
          version: v1.17.9

      - name: Install cargo-hack
        uses: clechasseur/rs-cargo@v5.0.5
        with:
          command: binstall
          args: -y cargo-hack@0.6.44

      - name: Run clippy
        uses: clechasseur/rs-clippy-check@v6.0.4
        with:
          args: --workspace --all-targets --feature-powerset -- -D warnings
          tool: cargo-hack
          cache-key: v1-clippy

  fmt:
    name: Rustfmt check
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust nightly with rustfmt
        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
        with:
          toolchain: nightly
          components: rustfmt
          cache: false

      - name: Run Rustfmt
        uses: clechasseur/rs-fmt-check@v4.0.4
        with:
          args: --all

  msrv-check:
    name: MSRV check on ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-24.04, macos-15, windows-2025 ]
        toolchain: [ 1.60.0 ] # TODO: change for your minimum supported Rust version
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust nightly and ${{ matrix.toolchain }}
        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
        with:
          toolchain: nightly,${{ matrix.toolchain }}
          cache: false

      - name: Rust Cache
        uses: clechasseur/rust-cache@45dfca100f1e255035d993b3dc7a8c356de54bf8
        with:
          prefix-key: v1.0.0-rust
          key: msrv-pins-files-${{ hashFiles('**/msrv-pins.toml') }}
          cache-on-failure: true

      - name: Setup cargo-binstall
        uses: cargo-bins/cargo-binstall@v1.17.9
        with:
          version: v1.17.9

      - name: Install required tools
        uses: clechasseur/rs-cargo@v5.0.5
        with:
          command: binstall
          args: -y just@1.48.1 cargo-hack@0.6.44 cargo-minimal-versions@0.1.37 cargo-msrv-prep@2.1.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Run checks using cargo-minimal-versions
        run: just toolchain=${{ matrix.toolchain }} check-minimal

  build:
    name: Build on ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        os: [ ubuntu-24.04, macos-15, windows-2025 ]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
        with:
          toolchain: stable
          cache: false

      - name: Rust Cache
        uses: clechasseur/rust-cache@45dfca100f1e255035d993b3dc7a8c356de54bf8
        with:
          prefix-key: v1.0.0-rust
          cache-on-failure: true

      - name: Setup cargo-binstall
        uses: cargo-bins/cargo-binstall@v1.17.9
        with:
          version: v1.17.9

      - name: Install required tools
        uses: clechasseur/rs-cargo@v5.0.5
        with:
          command: binstall
          args: -y just@1.48.1 cargo-hack@0.6.44
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Run checks on feature powerset
        run: just check-powerset

      - name: Run tests
        run: just test

  llvm-cov:
    name: Code coverage with llvm-cov
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust nightly
        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
        with:
          toolchain: nightly
          cache: false

      - name: Rust Cache
        uses: clechasseur/rust-cache@45dfca100f1e255035d993b3dc7a8c356de54bf8
        with:
          prefix-key: v1.0.0-rust
          cache-targets: false
          cache-on-failure: true

      - name: Setup cargo-binstall
        uses: cargo-bins/cargo-binstall@v1.17.9
        with:
          version: v1.17.9

      - name: Install required tools
        uses: clechasseur/rs-cargo@v5.0.5
        with:
          command: binstall
          args: -y just@1.48.1 cargo-llvm-cov@0.8.5
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Run cargo-llvm-cov
        run: just llvm-cov

      - name: Upload code coverage results to codecov.io
        uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: codecov.json
          fail_ci_if_error: true

      - name: Archive code coverage results
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: llvm-cov-code-coverage-report
          path: |
            codecov.json
            target/llvm-cov/html/

  doc:
    name: Rustdoc check
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout code
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust nightly
        uses: actions-rust-lang/setup-rust-toolchain@46268bd060767258de96ed93c1251119784f2ab6 # v1.16.1
        with:
          toolchain: nightly
          cache: false

      - name: Rust Cache
        uses: clechasseur/rust-cache@45dfca100f1e255035d993b3dc7a8c356de54bf8
        with:
          prefix-key: v1.0.0-rust
          cache-targets: false
          cache-on-failure: true

      - name: Setup cargo-binstall
        uses: cargo-bins/cargo-binstall@v1.17.9
        with:
          version: v1.17.9

      - name: Install just
        uses: clechasseur/rs-cargo@v5.0.5
        with:
          command: binstall
          args: -y just@1.48.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Generate doc using rustdoc
        run: just toolchain=nightly doc