test.yml

name: Test

# Run on both PRs and pushes to the main branch.
# It may seem redundant to run tests on main, since we disallow pushing directly
# to main and all PRs get tested before merging.
#
# But due to how GitHub Actions isolates caches, we need to run the tests on
# main so that caches are available to new PRs. The caches created when testing
# PR code cannot be re-used outside of testing that PR.
#
# See the GitHub Actions documentation here:
# https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows#restrictions-for-accessing-a-cache
on:
  push:
    branches: [main]
    paths:
      - "gitoid/**"
      - "omnibor/**"
      - "omnibor-cli/**"
      - "xtask/**"
  pull_request:
    branches: [main]
    paths:
      - "gitoid/**"
      - "omnibor/**"
      - "omnibor-cli/**"
      - "xtask/**"

permissions:
  contents: read

env:
  RUSTFLAGS: -Dwarnings
  CARGO_TERM_COLOR: always
  # Necessary for 'cargo-insta' to handle CI behavior correctly.
  CI: true

jobs:
  test:
    strategy:
      matrix:
        os: [ubuntu-latest, windows-latest, macos-latest]
    name: "${{ matrix.os }}"
    runs-on: ${{ matrix.os }}
    timeout-minutes: 15
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - uses: swatinem/rust-cache@v2
        with:
          key: ${{ matrix.os }}
      - name: Dependency Tree
        run: cargo tree
      - name: Check
        run: cargo check --verbose --workspace
      - name: Test
        run: cargo test --verbose --workspace
      - name: Lint
        run: cargo clippy --verbose --workspace