Add GitHub CI job to check Markdown links during PRs (#9003)
* Add action * Add job * Add broken link * Correct syntax for yamllint * Remove broken link to test * Re-add broken link as example for PR * Fixes for James * Rename to docs.yml
Joel Hans committed
May 19, 2020 at 15:01 UTC
5025a3d710e587fe340adfd94eb54a22e180518d
1 file changed
+24
.github/workflows/docs.yml
new
+24
@@ -0,0 +1,24 @@
1
+---
2
+name: Docs
3
+on:
4
+ push:
5
+ branches:
6
+ - master
7
+ paths:
8
+ - '*.md'
9
+ pull_request:
10
+ paths:
11
+ - '*.md'
12
+jobs:
13
+ markdown-link-check:
14
+ name: Broken Links
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - name: Checkout
18
+ uses: actions/checkout@v2
19
+ - name: Run link check
20
+ uses: gaurav-nelson/github-action-markdown-link-check@v1
21
+ with:
22
+ use-quiet-mode: 'yes'
23
+ use-verbose-mode: 'yes'
24
+ check-modified-files-only: 'yes'