test.yml

name: "Test Suite"
on:
  push:
  pull_request:

jobs:
  test:
    strategy:
      matrix:
        os:
          - ubuntu
          - macos
          - windows
        toolchain:
          - stable
          - 1.70
    name: cargo test on ${{ matrix.os }}
    runs-on: ${{ matrix.os }}-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions-rust-lang/setup-rust-toolchain@v1
        with:
          toolchain: ${{ matrix.toolchain }}
      - name: Cargo test
        run: cargo test

  # Check formatting with rustfmt
  mdbook:
    name: test mdBook
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # Ensure rustfmt is installed and setup problem matcher
      - uses: actions-rust-lang/setup-rust-toolchain@v1
        with:
          components: rustfmt
      - run: cargo build --workspace
      - name: test mdBook
        # rustdoc doesn't build dependencies, so it needs to run after `cargo build`,
        # but its dependency search gets confused if there are multiple copies of any
        # dependency in target/debug/deps, so it needs to run before `cargo test` et al.
        # clutter target/debug/deps with multiple copies of things.
        run: for file in $(find mdbook -name '*.md' | sort); do rustdoc --test $file  -L ./target/debug/deps; done