[CI] add a job to check for broken links

Signed-off-by: Sven Kieske <[email protected]>
osism · Dec 8, 2023 · 17030ba · 17030ba
1 parent c763d2b
commit 17030ba
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/.github/workflows/link-check.yml b/.github/workflows/link-check.yml
@@ -0,0 +1,15 @@
+name: Check Markdown links
+on:
+  push:
+
+jobs:
+  markdown-link-check:
+    name: Markdown Link Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: .github/workflows/markdown-link-check.json
+          use-quiet-mode: 'no'
+          use-verbose-mode: 'yes'
diff --git a/.github/workflows/markdown-link-check.json b/.github/workflows/markdown-link-check.json
@@ -0,0 +1,7 @@
+{
+    "ignorePatterns": [
+      {
+        "pattern": "^(?!http(s)?:\/\/.*)|^(https:\/\/.*((osism.xyz)|(in-a-box.cloud)))(:?[0-9]+)?(\/.*)?$"
+      }
+    ]
+  }