Use lychee link checker (#1022)

* Use lychee link checker
* Update checkout action version to v6.0.2

Author: soumeh01

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,6 @@
 ## Fixes
-<!-- List the GitHub issue this PR resolves -->
-
-- [#<Number>](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/issues/<number>)
+<!-- List the GitHub issue(s) this PR resolves (e.g. #123) -->
+- #<issue-number>
 
 ## Changes
 <!-- List the changes this PR introduces -->

.github/lychee.toml

@@ -0,0 +1,38 @@
+# For all options, see <https://lychee.cli.rs/usage/config/>
+
+# Verbose program output
+# Accepts log level: "error", "warn", "info", "debug", "trace"
+verbose = "info"
+
+# Interactive progress bar while checking links.
+# Disabled for CI usage
+no_progress = true
+cache = false
+
+accept = [
+    "200"
+]
+
+# Maximum number of allowed redirects.
+max_redirects = 2
+
+# Maximum number of allowed retries before a link is declared dead.
+max_retries = 2
+
+# Only test links with the given schemes
+# Omit to check links with any other scheme.
+scheme = ["http", "https", "file"]
+
+# Exclude links
+exclude = [
+    # Needs cookies to be accepted
+    'https://developer.arm.com',
+    'https://www.segger.com'
+]
+
+# Exclude paths from getting checked. The values are treated as regular expressions
+exclude_path = [
+    "(^|[\\\\/])CHANGELOG\\.md$", # skip changelog file
+    "\\.txt$",                  # skip .txt extensions
+    "\\.html$",                 # skip .html extensions
+]

.github/workflows/markdown.yml

@@ -45,35 +45,18 @@ jobs:
   check-links:
     name: Check Markdown Links
     runs-on: ubuntu-latest
-    permissions:
-      packages: read
     steps:
       - name: Harden the runner (Audit all outbound calls)
         uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
-
-      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          node-version-file: package.json
-          registry-url: https://npm.pkg.github.com
-          package-manager-cache: false
-
-      - name: Install dependencies
-        env:
-          GITHUB_TOKEN: ${{ github.token }}
-        run: npm ci
+      - name: Checkout repository
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
 
-      # Automatically retry the link check if it fails
-      # This helps reduce false positives in CI caused by transient errors
       - name: Check Links
-        if: runner.os == 'Linux'
-        uses: Wandalen/wretry.action@e68c23e6309f2871ca8ae4763e7629b9c258e1ea # v3.8.0
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
         with:
-          attempt_delay: 2000
-          attempt_limit: 3
-          command: npm run check:links
+          args: --config .github/lychee.toml './**/*.md'
+          fail: true
+          jobSummary: true

.github/workflows/nightly.yml

@@ -13,6 +13,24 @@ permissions:
   contents: read
 
 jobs:
+  validate-markdown-links:
+    name: Validate Markdown Links
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@9af89fc71515a100421586dfdb3dc9c984fbf411 # v2.19.4
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Validate Links
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
+        with:
+          args: --config .github/lychee.toml './**/*.md'
+          fail: true
+          jobSummary: false
+
   build:
     if: github.repository == 'Open-CMSIS-Pack/vscode-cmsis-debugger'
     strategy:
@@ -84,16 +102,6 @@ jobs:
         if: runner.os == 'Linux'
         run: npm run build
 
-      # Automatically retry the link check if it fails
-      # This helps reduce false positives in CI caused by transient errors
-      - name: Check Links
-        if: runner.os == 'Linux'
-        uses: Wandalen/wretry.action@e68c23e6309f2871ca8ae4763e7629b9c258e1ea # v3.8.0
-        with:
-          attempt_delay: 2000
-          attempt_limit: 3
-          command: npm run check:links
-
       - name: Check copyright
         if: runner.os == 'Linux'
         run: npm run copyright:check