docs: use link-inspector

open-telemetry · Jan 7, 2025 · 1fb2f27 · 1fb2f27
1 parent 035c32a
commit 1fb2f27
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 15 deletions.
diff --git a/.github/workflows/ci-markdown-link.yml b/.github/workflows/ci-markdown-link.yml
@@ -2,16 +2,19 @@ name: Markdown Link Check
 
 on:
   pull_request:
+    paths:
+      - '**/*.md'
 
 jobs:
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
 
-      - name: "Markdown Link Check"
-        uses: gaurav-nelson/github-action-markdown-link-check@v1
+      # equivalent cli: linkspector check
+      - name: Run linkspector
+        uses: umbrelladocs/action-linkspector@v1
         with:
-          config-file: '.markdown-link-check.json'
-          use-quiet-mode: 'yes'
-          use-verbose-mode: 'yes'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          fail_on_error: true
diff --git a/.markdown-link-check.json b/.markdown-link-check.json