ci.yml

name: CI # Continuous Integration

on:
  push:
    branches:
      - main
    paths-ignore:
      - "**.md"
  pull_request:
    paths-ignore:
      - "**.md"

env:
  RUSTFLAGS: -Dwarnings
  RUST_BACKTRACE: 1
  rust_stable: stable
  rust_clippy: "1.83.0"
  rust_min: "1.83.0"

jobs:
  # test:
  # https://github.com/Owen-CH-Leung/tokio/blob/623e4bb8fc4862f36d08643bd640c085668be054/.github/workflows/ci.yml

  # Basic actions that must pass before we kick off more expensive tests.
  basics:
    name: basic checks
    runs-on: ubuntu-latest
    needs:
      - minrust
      - deny
      - clippy
      - fmt
      - docs
    steps:
      - run: exit 0

  minrust:
    name: minrust
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Install Rust ${{ env.rust_min }}
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.rust_min }}
      - uses: Swatinem/rust-cache@v2
      - name: cargo check minrust
        run: cargo check --workspace --all-features
        env:
          RUSTFLAGS: "" # remove -Dwarnings

  fmt:
    name: fmt
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Install Rust ${{ env.rust_stable }}
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.rust_stable }}
          components: rustfmt
      - uses: Swatinem/rust-cache@v2
      - name: cargo fmt
        run: cargo fmt --all --check

  clippy:
    name: clippy
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Install Rust ${{ env.rust_clippy }}
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.rust_clippy }}
          components: clippy
      - uses: Swatinem/rust-cache@v2
      - name: cargo clippy
        run: cargo clippy --all --tests --all-features --no-deps --workspace

  deny:
    name: deny
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Install Rust Deny
        uses: taiki-e/install-action@v2
        with:
          tool: cargo-deny
      - uses: Swatinem/rust-cache@v2
      - name: cargo deny
        run: cargo deny --all-features check

  docs:
    name: docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
      - name: Install Rust ${{ env.rust_stable }}
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.rust_stable }}
      - uses: Swatinem/rust-cache@v2
      - name: cargo docs
        run: cargo doc --no-deps --document-private-items --all-features --workspace --examples

  # check-spelling:
  #   name: check-spelling
  #   needs: basics
  #   runs-on: ubuntu-latest
  #   steps:
  #     - name: Checkout repository
  #       uses: actions/checkout@v4
  #     - name: Install Rust ${{ env.rust_stable }}
  #       uses: dtolnay/rust-toolchain@stable
  #       with:
  #         toolchain: ${{ env.rust_stable }}
  #     - name: Install cargo-spellcheck
  #       uses: taiki-e/install-action@v2
  #       with:
  #         tool: cargo-spellcheck
  #     - uses: actions/checkout@v4
  #     - name: cargo spellcheck
  #       run: cargo spellcheck --code 1