Skip to content

Commit 5694863

Browse files
committed
Add CI workflow to check for broken links in docs
On every push or pull request, check for broken links in the Markdown files of the repository.
1 parent b29d515 commit 5694863

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

.github/workflows/check-links.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Check Links
2+
3+
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows
4+
on:
5+
push:
6+
paths:
7+
- ".github/workflows/check-links.yml"
8+
- "**.md"
9+
pull_request:
10+
paths:
11+
- ".github/workflows/check-links.yml"
12+
- "**.md"
13+
schedule:
14+
# Run every Tuesday at 3 AM UTC to catch breakage caused by changes to the linked sites.
15+
- cron: "0 3 * * TUE"
16+
workflow_dispatch:
17+
repository_dispatch:
18+
19+
jobs:
20+
check:
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v2
26+
27+
- name: Check links
28+
uses: gaurav-nelson/github-action-markdown-link-check@v1
29+
with:
30+
use-quiet-mode: yes

0 commit comments

Comments
 (0)