linkcheck.yml

name: Link Check

on:
  schedule:
    - cron: "0 6 * * 1"  # Weekly, Monday 6am UTC
  workflow_dispatch:

permissions:
  contents: read
  issues: write

jobs:
  linkcheck:
    name: Check for Dead Links
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Set up uv
        uses: astral-sh/setup-uv@eac588ad8def6316056a12d4907a9d4d84ff7a3b # v7.3.0
        with:
          enable-cache: true

      - name: Set up Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: "3.14"

      - name: Install dependencies
        run: uv sync

      - name: Run Sphinx linkcheck
        run: uv run sphinx-build -b linkcheck . _build/linkcheck -j auto --keep-going 2>&1 | tee linkcheck.log || true

      - name: Upload linkcheck results
        if: always()
        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
        with:
          name: linkcheck-results
          path: |
            _build/linkcheck/output.txt
            _build/linkcheck/output.json
            linkcheck.log
          retention-days: 30