diff --git a/.github/workflows/doc-check-links.yml b/.github/workflows/doc-check-links.yml new file mode 100644 index 00000000000..fd324618d08 --- /dev/null +++ b/.github/workflows/doc-check-links.yml @@ -0,0 +1,37 @@ +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@v5 + with: + fetch-depth: 0 + persist-credentials: false + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.11" + cache: pip + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install tox + + - name: Run sphinx linkcheck via tox + run: tox -e docs-checklinks diff --git a/AUTHORS b/AUTHORS index d09c4dc98b4..f93de06c10d 100644 --- a/AUTHORS +++ b/AUTHORS @@ -282,6 +282,7 @@ Marcin Augustynów Marcin Bachry Marc Bresson Marco Gorelli +Marcos Boger Mark Abramowitz Mark Dickinson Mark Vong diff --git a/changelog/12474.contrib.rst b/changelog/12474.contrib.rst new file mode 100644 index 00000000000..bb668fd66c5 --- /dev/null +++ b/changelog/12474.contrib.rst @@ -0,0 +1 @@ +Added scheduled GitHub Action Workflow to run Sphinx linkchecks in repo documentation.