Skip to content

Commit c467a58

Browse files
committed
MNT: Add GHA workflow file to check links in Markdown files
Add GHA workflow file to check links in Markdown files: signals broken links. Uses the `tcort/github-action-markdown-link-check` action from https://github.com/tcort/github-action-markdown-link-check
1 parent 96bf830 commit c467a58

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.github/workflows/linkcheck.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Check links
2+
3+
on:
4+
push:
5+
branches: [mkdocs]
6+
pull_request:
7+
branches: [mkdocs]
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
# Force to use color
14+
env:
15+
FORCE_COLOR: true
16+
17+
jobs:
18+
19+
link-check:
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Set up Python
27+
uses: actions/setup-python@v5
28+
with:
29+
python-version: 3.12
30+
31+
- uses: tcort/github-action-markdown-link-check@v1
32+
with:
33+
use-quiet-mode: yes
34+
# use-verbose-mode: no

0 commit comments

Comments
 (0)