Add GitHub action to validate links in markdown files (NVIDIA#1640)

Add GitHub action to run xrefcheck on markdown files.
alliepiper · Mar 29, 2022 · 0dbb0e0 · 0dbb0e0
1 parent b1bf1e9
commit 0dbb0e0
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/.github/workflows/xrefcheck-validate-markdown-links.yml b/.github/workflows/xrefcheck-validate-markdown-links.yml
@@ -0,0 +1,18 @@
+name: Check bad links
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+
+jobs:
+  xrefcheck:
+    name: Check links
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: serokell/xrefcheck-action@v1
+      with:
+        xrefcheck-version: 0.2
+        xrefcheck-args: --ignored dependencies
diff --git a/docs/github_pages/setup/requirements.md b/docs/github_pages/setup/requirements.md
@@ -6,7 +6,7 @@ nav_order: 0
 # Requirements
 
 All requirements are applicable to the `main` branch on GitHub.
-For details on specific releases, please see the [changelog].
+For details on specific releases, please see the [CHANGELOG.md].
 
 ## Usage Requirements