wg 1.0.1

name: CI

on:
  push:
    branches:
      - main
    paths-ignore:
      - 'README'
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**.md'
      - '**.txt'
  pull_request:
    paths-ignore:
      - 'README'
      - 'COPYRIGHT'
      - 'LICENSE-*'
      - '**.md'
      - '**.txt'
  workflow_dispatch:
  schedule: 
    - cron: "0 1 1 * *"

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -Dwarnings
  RUST_BACKTRACE: 1
  nightly: nightly
  stable: stable

jobs:
  # Check formatting (platform-independent, one OS is enough)
  rustfmt:
    name: rustfmt
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        run: rustup update stable && rustup default stable && rustup component add rustfmt
      - name: Check formatting
        run: cargo fmt --all -- --check


  # Verify the declared MSRV in Cargo.toml still builds.
  msrv:
    name: msrv
    runs-on: ubuntu-latest
    env:
      # MSRV may emit lints that current stable does not; don't fail on them.
      RUSTFLAGS: ""
    steps:
      - uses: actions/checkout@v6
      - name: Read MSRV from Cargo.toml
        id: msrv
        run: |
          ver=$(grep -m1 '^rust-version' Cargo.toml | sed -E 's/.*"([^"]+)".*/\1/')
          echo "version=$ver" >> "$GITHUB_OUTPUT"
      - name: Install MSRV toolchain (${{ steps.msrv.outputs.version }})
        run: rustup toolchain install ${{ steps.msrv.outputs.version }} --profile minimal
      - name: cargo +MSRV check --all-features
        run: cargo +${{ steps.msrv.outputs.version }} check --all-features


  # Apply clippy lints
  clippy:
    name: clippy
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
        run: rustup update stable --no-self-update && rustup default stable && rustup component add clippy
      - name: Install cargo-hack
        run: cargo install cargo-hack
      - name: Apply clippy lints
        run: cargo hack clippy --each-feature

  # Run tests on some extra platforms
  cross:
    name: cross
    strategy:
      matrix:
        target:
          - aarch64-unknown-linux-gnu
          - aarch64-linux-android
          - aarch64-unknown-linux-musl
          - i686-linux-android
          - x86_64-linux-android
          - i686-pc-windows-gnu
          - x86_64-pc-windows-gnu
          - i686-unknown-linux-gnu
          - powerpc64-unknown-linux-gnu
          - riscv64gc-unknown-linux-gnu
          - wasm32-unknown-unknown
          - wasm32-unknown-emscripten
          - wasm32-wasip1
          - wasm32-wasip1-threads
          - wasm32-wasip2
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Cache cargo build and registry
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-cross-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cross-
      - name: Install mingw-w64 (windows-gnu targets)
        # `parking_lot_core` invokes `<triple>-dlltool` when cross-compiling
        # to *-pc-windows-gnu. The GitHub ubuntu runners don't ship mingw-w64
        # by default.
        if: contains(matrix.target, 'pc-windows-gnu')
        run: sudo apt-get update && sudo apt-get install -y gcc-mingw-w64
      - name: Install Rust
        run: rustup update stable && rustup default stable
      - name: cargo build --target ${{ matrix.target }}
        run: |
          rustup target add ${{ matrix.target }}
          cargo build --target ${{ matrix.target }}
      - name: cargo check --all-features --target ${{ matrix.target }}
        # Catches platform-specific conditional-compilation misses like
        # `EventListener::wait()` not existing on wasm. Runs in addition
        # to the default-features build above.
        run: cargo check --all-features --target ${{ matrix.target }}

  build:
    name: build
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Cache cargo build and registry
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-build-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-build-
      - name: Install Rust
        # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
        run: rustup update stable --no-self-update && rustup default stable
      - name: Install cargo-hack
        run: cargo install cargo-hack
      - name: Run build (individual features)
        run: cargo hack build --each-feature
      - name: Run build (feature pairs)
        # `--each-feature` misses multi-feature combinations like
        # `alloc + future` that the README advertises. Test those
        # explicitly.
        run: |
          cargo build --no-default-features --features alloc,future
          cargo build --all-features
  
  test:
    name: test
    strategy:
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v6
      - name: Cache cargo build and registry
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-test-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-test-
      - name: Install Rust
        # --no-self-update is necessary because the windows environment cannot self-update rustup.exe.
        run: rustup update stable --no-self-update && rustup default stable
      - name: Install cargo-hack
        run: cargo install cargo-hack
      - name: Run test (individual features)
        run: cargo hack test --each-feature
      - name: Run test (feature pairs)
        # Cover the `alloc + future` combination that cargo-hack's
        # `--each-feature` mode does not reach, plus the full set.
        run: |
          cargo test --no-default-features --features alloc,future
          cargo test --all-features

  coverage:
    name: coverage
    runs-on: ubuntu-latest
    needs:
      - rustfmt
      - msrv
      - clippy
      - build
      - cross
      - test
    steps:
      - uses: actions/checkout@v6
      - name: Install Rust
        run: rustup update nightly && rustup default nightly
      - name: Install cargo-tarpaulin
        run: cargo install cargo-tarpaulin
      - name: Cache cargo build and registry
        uses: actions/cache@v5
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-coverage-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-coverage-
      - name: Run tarpaulin
        env:
          RUSTFLAGS: "--cfg tarpaulin"
        run: cargo tarpaulin --all-features --run-types tests --run-types doctests --workspace --out xml
      - name: Upload to codecov.io
        uses: codecov/codecov-action@v6
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          slug: ${{ github.repository }}
          fail_ci_if_error: true