Link checker (ChainSafe#5098)

docs/.config/lychee.toml → .config/lychee.toml

@@ -4,8 +4,20 @@
 
 verbose = "debug"
 no_progress = true
-# Requires CAPTCHA verification
-exclude = ["https://faucet.calibnet.chainsafe-fil.io/funds.html"]
-timeout = 60
+exclude_path = [
+    "./node_modules",
+    "./docs/node_modules",
+    "./documentation",
+    "./target"
+]
+exclude = [
+    # Avoid Github rate limits
+    "github.com/ChainSafe/forest",
+    # Requires CAPTCHA verification
+    "faucet.calibnet.chainsafe-fil.io/funds.html"
+]
+timeout = 30
 max_retries = 6
 retry_wait_time = 10
+
+output = "lychee-report.md"

.github/workflows/link-check.yml

@@ -0,0 +1,51 @@
+name: Link Checker
+
+on:
+  workflow_dispatch:
+  schedule:
+    # Run daily at 9am
+    - cron: "00 9 * * *"
+  push:
+    branches:
+      - main
+    paths:
+      - "**.md"
+      - "**.mdx"
+      - "**.html"
+      - ".github/workflows/link-check.yml"
+  merge_group:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "**.md"
+      - "**.mdx"
+      - "**.html"
+      - ".github/workflows/link-check.yml"
+
+jobs:
+  link-check:
+    name: Link Check
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      issues: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: --config ./.config/lychee.toml './**/*.md' './**/*.mdx' './**/*.html'
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0 && github.event_name == 'schedule'
+        uses: peter-evans/create-issue-from-file@v5
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee-report.md
+
+      - name: Fail job on error
+        if: env.lychee_exit_code != 0 && github.event_name != 'schedule'
+        run: exit 1

.gitignore

@@ -388,3 +388,5 @@ rust-project.json
 # .pnp.*
 
 # End of https://www.toptal.com/developers/gitignore/api/go,rust,rust-analyzer,osx,visualstudiocode,intellij+all,yarn,node,ruby
+
+lychee-report.md