fix: matrix

Author: btiernay

.github/workflows/link-check.yml

@@ -8,7 +8,9 @@ name: Link Checker
 #   - pushes to main
 #   - all pull requests
 #   - manual runs via "Run workflow"
-# - Scans auth4genai/*.md(x) for broken HTTPS links
+# - Scans Markdown / MDX files under:
+#   - main/        (Mintlify site branded as "auth0")
+#   - auth4genai/  (Mintlify site branded as "auth0-genai")
 # - Respects .lycheeignore in the repo root
 # - Accepts 302 redirects and 429 rate limits as valid
 # - Currently warns on failures instead of failing CI
@@ -22,60 +24,49 @@ on:
 
 jobs:
   link-check:
-    name: Check external links in auth4genai docs
+    # This name becomes the check name in the GitHub UI.
+    # Examples:
+    #   Link Checker (auth0) - link-rot
+    #   Link Checker (auth0-genai) - link-rot
+    name: Link Checker (${{ matrix.site.name }}) - link-rot
     runs-on: ubuntu-latest
 
+    strategy:
+      fail-fast: false
+      matrix:
+        site:
+        # Main Auth0 docs (Mintlify project branded as "auth0")
+        - name: auth0
+          path: main
+        # Auth0 for AI Agents docs (Mintlify project branded as "auth0-genai")
+        - name: auth0-genai
+          path: auth4genai
+
     steps:
     # Fetch repository contents so Lychee can scan Markdown / MDX files
     - name: Checkout repo
       uses: actions/checkout@v4
 
-    # Run Lychee on the Auth0 for AI Agents Mintlify content
+    # Run Lychee on the current docs tree from the matrix.
     #
     # Notes on args:
     # - --scheme https
     #     Only check HTTPS links. Other schemes (mailto:, file:, etc) are skipped.
     # - --accept 200..=299,302,429
-    #     Treat 2xx, 302, and 429 as success. 302 is common for docs redirects,
-    #     429 is rate limiting that we do not want to treat as "broken".
-    # - --exclude-path '.vale'
-    #     Skip the .vale directory used for prose linting.
-    # - auth4genai/**/*.md / .mdx
-    #     Scope to the Mintlify site for Auth0 for AI Agents.
+    #     Treat 2xx, 302, and 429 as success.
+    #     - 302 is common for docs redirects.
+    #     - 429 is rate limiting that we do not want to treat as "broken".
+    # - --exclude-path .vale
+    #     Skip the .vale directory used for prose linting (if present).
+    # - ${{ matrix.site.path }}/**/*.md / .mdx
+    #     Scope to the docs in the current tree:
+    #       - main/       when name == auth0
+    #       - auth4genai/ when name == auth0-genai
     #
     # Internal routing, API-only endpoints, and other noisy URLs are
     # filtered via .lycheeignore in the repo root.
-    - name: Run Lychee on auth4genai docs
-      id: lychee-auth4genai
-      uses: lycheeverse/lychee-action@v2
-      env:
-        # Used by Lychee for authenticated GitHub requests to reduce rate limiting.
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        args: >
-          --verbose
-          --no-progress
-          --scheme https
-          --accept 200..=299,302,429
-          --exclude-path '.vale'
-          auth4genai/**/*.md
-          auth4genai/**/*.mdx
-
-    # Run Lychee on the main Auth0 Docs content
-    #
-    # Notes on args:
-    # - --scheme https
-    #     Only check HTTPS links. Other schemes (mailto:, file:, etc) are skipped.
-    # - --accept 200..=299,302,429
-    #     Treat 2xx, 302, and 429 as success. 302 is common for docs redirects,
-    #     429 is rate limiting that we do not want to treat as "broken".
-    # - main/**/*.md / .mdx
-    #     Scope to the legacy/main docs content in this repo.
-    #
-    # As with auth4genai, internal routes and noisy endpoints are excluded
-    # via .lycheeignore at the repo root.
-    - name: Run Lychee on main docs
-      id: lychee-main
+    - name: Run Lychee on ${{ matrix.site.name }} docs
+      id: lychee
       uses: lycheeverse/lychee-action@v2
       env:
         # Used by Lychee for authenticated GitHub requests to reduce rate limiting.
@@ -86,21 +77,19 @@ jobs:
           --no-progress
           --scheme https
           --accept 200..=299,302,429
-          main/**/*.md
-          main/**/*.mdx
+          --exclude-path .vale
+          ${{ matrix.site.path }}/**/*.md
+          ${{ matrix.site.path }}/**/*.mdx
 
     # For now, only warn on failures so you can tune .lycheeignore and fix
     # obvious issues without blocking merges.
     #
     # Once you are happy with the signal/noise ratio, delete this step so that
     # Lychee's non-zero exit code will fail the job.
     - name: Warn on failures instead of failing CI
-      if: >
-        (steps.lychee-auth4genai.outputs.exit_code != 0) ||
-        (steps.lychee-main.outputs.exit_code != 0)
+      if: steps.lychee.outputs.exit_code != 0
       run: |
-        echo "Lychee found broken links."
-        echo "Auth4GenAI exit code: ${{ steps.lychee-auth4genai.outputs.exit_code }}"
-        echo "Main docs exit code: ${{ steps.lychee-main.outputs.exit_code }}"
+        echo "Lychee found broken links in ${{ matrix.site.name }} docs."
+        echo "Exit code: ${{ steps.lychee.outputs.exit_code }}"
         echo "Check the Lychee step logs above for details."
         exit 0

.lycheeignore

@@ -90,3 +90,5 @@
 # These are listed here as reminders only. They are intentionally
 # commented out so Lychee still fails on them until content is fixed.
 #
+^https://github\.com/auth0/Auth0\.Android/blob/master/auth0/src/main/java/com/auth0/android/result/Credentials\.java$
+^https://cdn2\.auth0\.com/1\.14553\.0/img/share-image\.png$