ci.yml

# Metadata for the actions workflow
name: CI
on:
  push:
    branches: ["main"]
  pull_request:
    branches: ["*"]

# Environment variables that will be set on all runners
env:
  DEV_SHELL_LINUX: "nix --store ~/nix_store develop '.#ci'"
  DEV_SHELL_MACOS: "nix develop '.#ci'"
  CARGO_TERM_COLOR: always # Always colour Cargo's output.
  CARGO_INCREMENTAL: 0 # Always run without incremental builds on CI.
  CARGO_PROFILE_DEV_DEBUG: 0 # Don't embed debug info even though the build is a dev build.

# Configuration for individual jobs
jobs:
  # This job is responsible for running the unit and integration tests
  test:
    name: "Test"
    strategy:
      fail-fast: false
      matrix:
        os: ["ubuntu-latest", "macos-latest"]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3
      - name: Install Lix
        shell: "bash"
        run: |
          curl -sSf -L https://install.lix.systems/lix | sh -s -- install --no-confirm
      - name: Setup Devshell Command
        shell: "bash"
        run: |
          if [ "$RUNNER_OS" == "Linux" ]; then
              echo "DEV_SHELL=${{ env.DEV_SHELL_LINUX }}" >> $GITHUB_ENV
          elif [ "$RUNNER_OS" == "macOS" ]; then
              echo "DEV_SHELL=${{ env.DEV_SHELL_MACOS }}" >> $GITHUB_ENV
          else
              exit 1
          fi
      - name: Restore Nix Cache
        uses: actions/cache@v3
        if: runner.os != 'macOS'
        continue-on-error: true
        with:
          path: |
            ~/nix_store
          key: nix-${{ hashFiles('**/flake.lock') }}-${{ matrix.os }}
      - name: Restore Rust Cache
        uses: actions/cache@v3
        continue-on-error: true
        with:
          path: |
            target/
          key: rust-${{ hashFiles('**/Cargo.lock') }}-${{ matrix.os }}
      - name: Build Lix Dependencies
        shell: "bash"
        run: |
          eval "$DEV_SHELL --command which cc"
      - name: Build Tests
        shell: "bash"
        run: |
          eval "$DEV_SHELL --command cargo test --all-targets --no-run"
      - name: Run Tests
        shell: "bash"
        run: |
          eval "$DEV_SHELL --command cargo test --all-targets -- --nocapture"

  # This job runs the linter.
  lint:
    name: "Lint Code"
    runs-on: "ubuntu-latest"
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3
      - name: Install Lix
        shell: bash
        run: |
          curl -sSf -L https://install.lix.systems/lix | sh -s -- install --no-confirm
      - name: Restore Nix Cache
        uses: actions/cache@v3
        continue-on-error: true
        with:
          path: |
            ~/nix_store
          key: nix-${{ hashFiles('**/flake.lock') }}-ubuntu-latest
      - name: Restore Rust Cache
        uses: actions/cache@v3
        continue-on-error: true
        with:
          path: |
            target/
          key: rust-${{ hashFiles('**/Cargo.lock') }}-ubuntu-latest
      - name: Build Lix Dependencies
        shell: bash
        run: |
          ${{ env.DEV_SHELL_LINUX }}
      - name: Lint Code
        shell: bash
        run: |
          ${{ env.DEV_SHELL_LINUX }} --command cargo clippy --all-targets --all-features

  # This job checks the formatting of the code and other artifacts.
  formatting:
    name: "Check Formatting"
    runs-on: "ubuntu-latest"
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3
      - name: Install Lix
        shell: bash
        run: |
          curl -sSf -L https://install.lix.systems/lix | sh -s -- install --no-confirm
      - name: Restore Nix Cache
        uses: actions/cache@v3
        continue-on-error: true
        with:
          path: |
            ~/nix_store
          key: nix-${{ hashFiles('**/flake.lock') }}-ubuntu-latest
      - name: Restore Rust Cache
        uses: actions/cache@v3
        continue-on-error: true
        with:
          path: |
            target/
          key: rust-${{ hashFiles('**/Cargo.lock') }}-ubuntu-latest
      - name: Build Lix Dependencies
        shell: bash
        run: |
          ${{ env.DEV_SHELL_LINUX }}
      - name: Check Formatting
        shell: bash
        run: |
          ${{ env.DEV_SHELL_LINUX }} --command cargo fmt --all -- --check
      - name: Install Node Deps
        shell: bash
        run: |
          ${{ env.DEV_SHELL_LINUX }} --command npm install
      - name: Lint Documentation
        shell: bash
        run: |
          ${{ env.DEV_SHELL_LINUX }} --command npx prettier --check .