Skip to content

Commit 1d39ee1

Browse files
author
Cecile Robert-Michon
committed
Add documentation linter to validate links
1 parent e1597ec commit 1d39ee1

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

.github/workflows/lint-docs.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Check Markdown links
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- '**.md'
9+
pull_request:
10+
paths:
11+
- '**.md'
12+
13+
jobs:
14+
markdown-link-check:
15+
name: Broken Links
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@master
19+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
20+
with:
21+
config-file: .markdownlinkcheck.json

.markdownlinkcheck.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^http://localhost"
5+
}
6+
],
7+
"timeout": "5s",
8+
"retryOn429": true,
9+
"retryCount": 5,
10+
"fallbackRetryDelay": "30s",
11+
"aliveStatusCodes": [200, 206]
12+
}

0 commit comments

Comments
 (0)