ci.yml

name: CI

on:
  merge_group:
  pull_request:
  workflow_dispatch:

concurrency:
  group: ci-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  lint:
    runs-on: ubuntu-latest

    steps:
      - name: Log github refs
        run: |
          {
            echo '```'
            echo 'github.ref: ${{ github.ref }}'
            echo 'github.sha: ${{ github.sha }}'
            echo '```'
          } >> "$GITHUB_STEP_SUMMARY"

      - uses: actions/checkout@v4

      - uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            ~/.dylint_drivers/
            ~/.rustup/toolchains/
          key: ${{ runner.os }}-drivers-${{ hashFiles('driver/**') }}

      - name: Install dylint-link
        run: cargo install --path ./dylint-link --force

      - name: Actionlint
        run: |
          go install github.com/rhysd/actionlint/cmd/actionlint@latest
          "$HOME"/go/bin/actionlint

      - name: Shellcheck
        run: shellcheck --exclude=SC2002 scripts/*

      - name: Install tools
        run: |
          # smoelius: Prettier is still needed for scripts/update_example_READMEs.sh.
          npm install -g prettier
          rm -f "$HOME"/.cargo/bin/cargo-fmt
          rm -f "$HOME"/.cargo/bin/rustfmt
          rustup install nightly
          rustup component add rustfmt --toolchain nightly
          cargo install cargo-license || true
          cargo install cargo-rdme    || true
          cargo install cargo-sort    || true

      - name: Cargo sort
        run: find . -name Cargo.toml -print0 | xargs -0 -n 1 dirname | xargs -n 1 cargo sort --check --grouped

      - name: Format
        run: ./scripts/format.sh && git diff --exit-code

      - name: Format example READMEs
        run: ./scripts/update_example_READMEs.sh && git diff --exit-code

      - name: Format util READMEs
        run: ./scripts/update_util_READMEs.sh && git diff --exit-code

      - name: Check lockfiles
        run: ./scripts/update_lockfiles.sh && git diff --exit-code

      - name: Check licenses
        run: ./scripts/check_licenses.sh

      - name: Lint
        run: ./scripts/lint.sh

  test:
    strategy:
      fail-fast: false
      matrix:
        environment: [ubuntu-latest, macos-latest, windows-latest]
        package: [cargo-dylint, examples, other]

    runs-on: ${{ matrix.environment }}

    defaults:
      run:
        shell: bash

    steps:
      - uses: actions/checkout@v4

      # smoelius: The `nightly_toolchain` test makes sense only if the nightly driver is cached.
      - uses: actions/cache@v3
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            ~/.dylint_drivers/
            ~/.rustup/toolchains/
          key: ${{ runner.os }}-drivers-${{ hashFiles('driver/**') }}

      - name: Rustup
        run: rustup update

      - name: Install dylint-link
        run: cargo install --path ./dylint-link --force

      # smoelius: This list will grow: https://github.com/trailofbits/dylint/issues/636
      - name: Install tools
        run: |
          npm install -g prettier
          rustup install nightly
          cargo install cargo-hack         || true
          cargo install cargo-msrv         || true
          cargo install cargo-supply-chain || true
          cargo install cargo-udeps        || true

      - name: Free up space on Ubuntu
        if: ${{ matrix.environment == 'ubuntu-latest' }}
        run: |
          # https://github.com/actions/runner-images/issues/2606#issuecomment-772683150
          sudo rm -rf /usr/local/lib/android
          sudo rm -rf /usr/share/dotnet
          sudo rm -rf /usr/share/swift
          # du -sh /usr/*/* 2>/dev/null | sort -h || true

      - name: Test
        run: |
          if [[ '${{ matrix.environment }}' = 'windows-latest' ]]; then
            export CARGO_INCREMENTAL=0
          fi
          if [[ '${{ matrix.package }}' != 'other' ]]; then
            cargo test -p '${{ matrix.package }}' --all-features -- --nocapture
          else
            cargo test --workspace --exclude cargo-dylint --exclude examples --all-features -- --nocapture

            pushd driver
            cargo test --all-features -- --nocapture
            popd

            pushd utils/linting
            cargo test --all-features -- --nocapture
            popd

            # smoelius: The `cdylib` -> `lib` trick is due to @MinerSebas.
            for X in examples/*/*; do
              if [[ ! -d "$X" ]]; then
                continue
              fi
              if [[ "$(basename "$X")" = '.cargo' || "$(basename "$X")" = 'src' ]]; then
                  continue
              fi
              pushd "$X"
              sed -i.bak 's/"cdylib"/"lib"/g' Cargo.toml
              cargo test --doc
              popd
            done
          fi

  all-checks:
    needs: [lint, test]

    runs-on: ubuntu-latest

    steps:
      - run: true