Switch to checking for dead links in the docs/CI HTML via Lychee (#733)

MFlowCode · Nov 15, 2024 · ec01950 · ec01950
1 parent 62bb2f3
commit ec01950
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 45 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -47,6 +47,12 @@ jobs:
         echo "url-count = ${{ steps.sitemap.outputs.url-count }}"
         echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}"
 
+    - name: Linkcheck - Lychee
+      uses: lycheeverse/lychee-action@v2
+      with:
+        args: -c .lychee.toml build/install/docs/mfc/
+        fail: false
+
     - name: Publish Documentation
       if:   github.repository == 'MFlowCode/MFC' && github.ref == 'refs/heads/master' && ( github.event_name == 'cron' || github.event_name == 'workflow_dispatch' )
       run:  |

diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml
diff --git a/.link_config.json b/.link_config.json
diff --git a/.lychee.toml b/.lychee.toml
@@ -0,0 +1,17 @@
+# Maximum number of allowed retries before a link is declared dead.
+max_retries = 5
+
+# Don't show interactive progress bar while checking links.
+no_progress = true
+
+# Website timeout from connect to response finished.
+timeout = 20
+
+# Minimum wait time in seconds between retries of failed requests.
+retry_wait_time = 4
+
+# Comma-separated list of accepted status codes for valid links.
+# accept = ["200", "206", "403", "429"]
+accept = ["200", "429"]
+
+verbose = "error"