Check links

.github/workflows/broken-link-checker.yml

@@ -0,0 +1,60 @@
+name: Check links
+
+on:
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+  # schedule:
+  #     - cron: '30 12 * * 1-5'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      issues: write
+    env:
+      issue-lookup-label: automated-link-issue
+      issue-content: ./lychee-out.md
+    steps:
+      - 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: Link Checker
+        id: lychee
+        uses: lycheeverse/[email protected]
+        with:
+          fail: true
+          args: --verbose --no-progress '**/*.md'
+          output: ${{ env.issue-content }}
+
+      # Permissions (issues: read)
+      - name: "Look for an existing issue"
+        if: ${{ failure() }}
+        id: last-issue
+        uses: micalevisk/last-issue-action@v2
+        # Find the last updated open issue with a `automated-issue` label:
+        with:
+          state: open
+          labels: ${{ env.issue-lookup-label }}
+
+      # Permissions (issues: write)
+      - name: "Create a new issue, or update an existing one"
+        if: ${{ failure() }}
+        uses: peter-evans/create-issue-from-file@v4
+        with:
+          title: "docs: Broken links found"
+          content-filepath: ${{ env.issue-content }}
+          # Update an existing issue if one was found (issue_number),
+          # otherwise an empty value creates a new issue:
+          issue-number: ${{ steps['last-issue']['outputs']['issue-number'] }}
+          # Add a label(s) that `last-issue` can use to find this issue,
+          # and any other relevant labels for the issue itself:
+          labels: |
+            ${{ env.issue-lookup-label }}
+            broken-link, docs