ci.yml

name: CI
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: full
jobs:
  cargo_fmt:
    name: Cargo format
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: cargo fmt
        run: cargo fmt --all -- --check
  taplo_checks:
    name: Toml validation
    runs-on: ubuntu-latest
    container:
      image: tamasfe/taplo:0.8.0
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: taplo lint
        run: taplo lint
      - name: taplo fmt
        run: taplo fmt --check --diff
  cargo_test:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: Run tests
        # https://github.com/actions/runner/issues/241, required to make the stdin.isterminal() conditionals work.
        shell: 'script --quiet --return --command "bash {0}"'
        run: cargo test --all-features -- --include-ignored --nocapture
  clippy:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: Run clippy
        run: cargo clippy --all-features --tests -- -D warnings
  mdbook_validation:
    name: mdBook validation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: mdBook setup
        uses: peaceiris/actions-mdbook@v2
        with:
          mdbook-version: 'latest'
      - name: Run mdbook test
        run: mdbook test
  docs_validation:
    name: Docs validation
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: Run cargo doc
        env:
          RUSTDOCFLAGS: "-D warnings"
        # Because CLI binary is also called `rops`:
        run: cargo doc --no-deps --all-features --workspace --exclude rops-cli
  spelling:
    name: Spell checking
    runs-on: ubuntu-latest
    steps:
    - name: Checkout sources
      uses: actions/checkout@v4
    - name: typos
      uses: crate-ci/typos@master
  audit:
    name: Audit
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: taiki-e/install-action@cargo-deny
      - name: Vulnerability scanning
        run: cargo deny check advisories
  unused:
    name: Unused
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: Run cargo-udeps
        uses: aig787/cargo-udeps-action@v1
        with:
          args: --all-features
  lychee_links:
    name: Links
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Run lychee
        uses: lycheeverse/lychee-action@v1.9.3
        with:
          fail: true
  coverage:
    name: Coverage
    runs-on: ubuntu-latest
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Build setup
        uses: ./.github/actions/build_setup
      - name: Install cargo-llvm-cov
        uses: taiki-e/install-action@cargo-llvm-cov
      - name: Generate code coverage
        # https://github.com/actions/runner/issues/241, required to make the stdin.isterminal() conditionals work.
        shell: 'script --quiet --return --command "bash {0}"'
        run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
      - name: Upload coverage to Codecov
        uses: codecov/codecov-action@v4
        with:
          token: ${{ secrets.CODECOV_TOKEN }}
          files: lcov.info
          fail_ci_if_error: true