Skip to content

Commit 806a670

Browse files
authored
Run Link Checks via scheduled workflow (#13682)
Fixes #12474
1 parent c69156e commit 806a670

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Doc Check Links
2+
3+
on:
4+
schedule:
5+
# At 00:00 on Sunday.
6+
# https://crontab.guru
7+
- cron: '0 0 * * 0'
8+
workflow_dispatch:
9+
10+
# Set permissions at the job level.
11+
permissions: {}
12+
13+
jobs:
14+
doc-check-links:
15+
if: github.repository_owner == 'pytest-dev'
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v5
21+
with:
22+
fetch-depth: 0
23+
persist-credentials: false
24+
25+
- name: Setup Python
26+
uses: actions/setup-python@v5
27+
with:
28+
python-version: "3.11"
29+
cache: pip
30+
31+
- name: Install dependencies
32+
run: |
33+
python -m pip install --upgrade pip
34+
pip install tox
35+
36+
- name: Run sphinx linkcheck via tox
37+
run: tox -e docs-checklinks

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,7 @@ Marcin Augustynów
282282
Marcin Bachry
283283
Marc Bresson
284284
Marco Gorelli
285+
Marcos Boger
285286
Mark Abramowitz
286287
Mark Dickinson
287288
Mark Vong

changelog/12474.contrib.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added scheduled GitHub Action Workflow to run Sphinx linkchecks in repo documentation.

0 commit comments

Comments
 (0)