Switch link checker to lychee

Author: trask

.github/config/markdown-link-check-config.json

@@ -120,7 +120,7 @@ jobs:
     # and so would not short-circuit if used in the second-last position
     name: publish-snapshots${{ (github.ref_name != 'main' || github.repository != 'open-telemetry/opentelemetry-java-contrib') && ' (skipped)' || '' }}
     needs:
-      # intentionally not blocking snapshot publishing on markdown-link-check or misspell-check
+      # intentionally not blocking snapshot publishing on link-check or misspell-check
       - build
       - integration-test
     runs-on: ubuntu-latest

.github/scripts/markdown-link-check-with-retry.sh

@@ -1,21 +1,21 @@
-name: Reusable - Markdown link check
+name: Reusable - Check links
 
 on:
   workflow_call:
 
 jobs:
-  markdown-link-check:
+  check-links:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install markdown-link-check
-        # TODO(jack-berg): use latest when config file reading bug is fixed: https://github.com/tcort/markdown-link-check/issues/246
-        run: npm install -g [email protected]
-
-      - name: Run markdown-link-check
-        run: |
-          find . -type f \
-                 -name '*.md' \
-                 -not -path './CHANGELOG.md' \
-               | xargs .github/scripts/markdown-link-check-with-retry.sh
+      - uses: lycheeverse/lychee-action@v2
+        with:
+          # remove version after next release of lychee-action
+          lycheeVersion: latest
+          # excluding links to pull requests and issues is done for performance
+          args: >
+            --include-fragments
+            --exclude "^https://github.com/open-telemetry/opentelemetry-java-instrumentation/(issue|pull)/\\d+$"
+            --max-retries 6
+            .