doc-test.yml

name: Tests in docs

on:
  pull_request:
    branches:
      - '*'
    paths:
      - 'src/**'
      - '.github/workflows/doc-test.yml'
      - 'justfile'

  workflow_dispatch:
  push: # Rebuild cache policy
    branches:
      - 'main'
    paths:
      - 'Cargo.lock'
      - 'Cargo.toml'

jobs:
  doc_unit_tests:
    name: Documentation Unit Tests
    runs-on: ubuntu-latest
    timeout-minutes: 25

    concurrency:
      group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
      cancel-in-progress: true

    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Cache Cargo Registry and Target Directory
        uses: actions/cache@v4.0.2
        id: cache-cargo
        with:
          path: |
            ~/.cargo/registry
            ~/.cargo/git
            target
          key: ${{ runner.os }}-v2-cargo-test-${{ hashFiles('Cargo.lock', 'Cargo.toml') }}
          restore-keys: |
            ${{ runner.os }}-v2-cargo-test-

      - name: Set up Rust
        if: ${{ steps.cache-cargo.outputs.cache-hit != 'true' }}
        run: curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y

      - name: Install protoc
        run: sudo apt-get install -y protobuf-compiler

      - name: Set up Just
        uses: extractions/setup-just@v1

      - name: Test docs
        run: just test-doc