Configure link checking (#46)

Author: ladvoc

.github/workflows/ci.yml

@@ -17,6 +17,9 @@ jobs:
   license-check:
     name: License Check
     uses: ./.github/workflows/license_check.yml
+  link-check:
+    name: Link Check
+    uses: ./.github/workflows/link_check.yml
   registry-check:
     name: Registry Check
     uses: ./.github/workflows/esp_registry.yml

.github/workflows/link_check.yml

@@ -0,0 +1,24 @@
+name: Link Check
+on:
+  workflow_call: {}
+  workflow_dispatch: {}
+jobs:
+  check-links:
+    name: Link Check
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Restore lychee cache
+        uses: actions/cache@v4
+        with:
+          path: .lycheecache
+          key: cache-lychee-${{ github.sha }}
+          restore-keys: cache-lychee-
+      - name: Run lychee
+        uses: lycheeverse/lychee-action@v2
+        with:
+          args: "--verbose --no-progress --cache --max-cache-age 1d ."
+          fail: true

.gitignore

@@ -38,4 +38,7 @@ coverage_report/
 .vscode
 
 # Doxygen
-docs/output
+docs/output
+
+# Lychee
+.lycheecache

licenserc.toml

@@ -22,7 +22,8 @@ excludes = [
     "CMakeLists.txt",
     "idf_component.yml",
     "license.txt",
-    "Kconfig"
+    "Kconfig",
+    "lychee.toml"
 ]
 
 [properties]

lychee.toml

@@ -0,0 +1,3 @@
+exclude_path = ["docs/customization/*"]
+cache = true
+max_cache_age = "1d"