doc-check-links.yml

name: Doc Check Links

on:
  schedule:
    # At 00:00 on Sunday.
    # https://crontab.guru
    - cron: '0 0 * * 0'
  workflow_dispatch:

# Set permissions at the job level.
permissions: {}

jobs:
  doc-check-links:
    if: github.repository_owner == 'pytest-dev'
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Setup Python
        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
        with:
          python-version: "3.13"
          cache: pip

      - name: Install tox
        run: |
          python -m pip install --upgrade pip
          pip install tox

      - name: Run sphinx linkcheck via tox
        run: tox -e docs-checklinks