link checker for website

ESMValGroup · May 3, 2024 · 3b1c585 · 3b1c585
1 parent 23d6145
commit 3b1c585
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.github/link-checker-config.json b/.github/link-checker-config.json
@@ -0,0 +1,13 @@
+{
+  "projectBaseUrl":"${https://github.com/ESMValGroup/ESMValTool-website}",
+  "ignorePatterns": [
+    {
+      "pattern": "^http://example.net"
+    }
+  ],
+  "timeout": "20s",
+  "retryOn429": true,
+  "retryCount": 5,
+  "fallbackRetryDelay": "30s",
+  "aliveStatusCodes": [200, 206]
+}
diff --git a/.github/workflows/link-checker.yml b/.github/workflows/link-checker.yml
@@ -0,0 +1,15 @@
+name: Check Markdown links
+
+on: push
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-quiet-mode: 'yes'
+        use-verbose-mode: 'yes'
+        config-file: 'link-checker-config.json'
+        folder-path: 'docs/markdown_files'