pr-checks.yml

name: Check docs structure
on:
  - pull_request
  - push
  - workflow_dispatch
jobs:
  build:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4

      - name: Install dependencies
        run: |
            sudo apt-get install python3-pip python3-setuptools python3-wheel --assume-yes --install-recommends

      - name: Create the Python virtual environment
        run: |
            python3 -mvenv venv
            source ./venv/bin/activate
            pip3 install --requirement requirements.txt .

      - name: Check for broken redirects
        run: ./tools/find-broken-redirects

      - name: Check for missing pages
        run: ./tools/find-missing

      - name: Check for orphaned pages
        run: ./tools/find-orphans

      - name: Check for trailing whitespace
        run: ./tools/find-whitespace

      - name: Lint YAML
        run: yamllint docs/

      - name: Build the docs site
        if: github.event_name != 'push'
        run: |
          mkdocs build