Check rendered docs links locally

Author: kkraus14

.github/workflows/build-docs.yml

@@ -253,26 +253,12 @@ jobs:
         run: |
           echo "${{ github.sha }}" > artifacts/docs/.preview-commit
 
-      - name: Write doc preview link-check URL list
-        if: ${{ !inputs.is-release && github.ref_name != 'main' && !startsWith(github.ref_name, 'release/') }}
-        env:
-          PREVIEW_URL: https://nvidia.github.io/cuda-python/pr-preview/pr-${{ env.PR_NUMBER }}
-        run: |
-          find "${GITHUB_WORKSPACE}/artifacts/docs" -type f -name '*.html' ! -path '*/_static/*' -printf '%P\n' \
-            | LC_ALL=C sort \
-            | sed "s#^#${PREVIEW_URL}/#" > lychee-preview-urls.txt
-          if [[ ! -s lychee-preview-urls.txt ]]; then
-            echo "error: no rendered HTML pages found for lychee" >&2
-            exit 1
-          fi
-          wc -l lychee-preview-urls.txt
-
-      - name: Upload doc preview link-check URL list
+      - name: Upload rendered docs for link checking
         if: ${{ !inputs.is-release && github.ref_name != 'main' && !startsWith(github.ref_name, 'release/') }}
         uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a  # v7.0.1
         with:
-          name: docs-preview-linkcheck-urls
-          path: lychee-preview-urls.txt
+          name: docs-rendered-html
+          path: artifacts/docs/
           if-no-files-found: error
           retention-days: 3
 

.github/workflows/check-doc-links.yml

@@ -7,10 +7,10 @@ name: "CI: Check rendered docs links"
 on:
   workflow_call:
     inputs:
-      url-artifact:
-        description: "Artifact containing the rendered doc preview URL list"
+      docs-artifact:
+        description: "Artifact containing the rendered docs HTML tree"
         required: false
-        default: docs-preview-linkcheck-urls
+        default: docs-rendered-html
         type: string
 
 jobs:
@@ -26,54 +26,45 @@ jobs:
       run:
         shell: bash -el {0}
     steps:
-      - name: Checkout ${{ github.event.repository.name }}
-        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
-
-      - name: Get PR number
-        uses: ./.github/actions/get_pr_number
+      - name: Extract PR number
+        run: |
+          PR_NUMBER="${GITHUB_REF_NAME#pull-request/}"
+          if [[ ! "${PR_NUMBER}" =~ ^[0-9]+$ ]]; then
+            echo "error: cannot extract PR number from ref ${GITHUB_REF_NAME}" >&2
+            exit 1
+          fi
+          echo "PR_NUMBER=${PR_NUMBER}" >> "${GITHUB_ENV}"
 
-      - name: Download doc preview link-check URL list
+      - name: Download rendered docs
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c  # v8.0.1
         with:
-          name: ${{ inputs.url-artifact }}
-          path: linkcheck-input
+          name: ${{ inputs.docs-artifact }}
+          path: rendered-docs
 
-      - name: Wait for doc preview deployment
-        env:
-          PREVIEW_URL: https://nvidia.github.io/cuda-python/pr-preview/pr-${{ env.PR_NUMBER }}
-          EXPECTED_SHA: ${{ github.sha }}
+      - name: Write rendered docs file list
         run: |
-          preview_ready=0
-          marker_url="${PREVIEW_URL}/.preview-commit"
-          for attempt in {1..60}; do
-            marker=$(curl -fsSL "${marker_url}" || true)
-            if [[ "${marker}" == "${EXPECTED_SHA}" ]]; then
-              preview_ready=1
-              break
-            fi
-            echo "Waiting for doc preview marker ${marker_url} (${attempt}/60)"
-            sleep 10
-          done
-          if [[ "${preview_ready}" != "1" ]]; then
-            echo "error: doc preview marker did not update to ${EXPECTED_SHA}" >&2
+          find "${GITHUB_WORKSPACE}/rendered-docs" -type f -name '*.html' ! -path '*/_static/*' \
+            | LC_ALL=C sort > lychee-rendered-html-files.txt
+          if [[ ! -s lychee-rendered-html-files.txt ]]; then
+            echo "error: no rendered HTML pages found for lychee" >&2
             exit 1
           fi
-          echo "Doc preview is available at ${PREVIEW_URL}"
+          wc -l lychee-rendered-html-files.txt
 
       - name: Restore lychee cache
         id: restore-lychee-cache
         uses: actions/cache/restore@0057852bfaa89a56745cba8c7296529d2fc39830  # v4
         with:
           path: .lycheecache
-          key: docs-preview-lychee-${{ env.PR_NUMBER }}-${{ github.sha }}
+          key: docs-rendered-lychee-${{ env.PR_NUMBER }}-${{ github.sha }}
           restore-keys: |
-            docs-preview-lychee-${{ env.PR_NUMBER }}-
+            docs-rendered-lychee-${{ env.PR_NUMBER }}-
 
-      - name: Check doc preview links
+      - name: Check rendered docs links
         uses: lycheeverse/lychee-action@6da1d14f3a43098a294b7696d93d938aa8d20fc0  # unreleased: supports v0.24.x archive layout
         with:
           args: >-
-            --files-from ${{ github.workspace }}/linkcheck-input/lychee-preview-urls.txt
+            --files-from ${{ github.workspace }}/lychee-rendered-html-files.txt
             --include-fragments=full
             --cache
             --max-cache-age 1d
@@ -89,7 +80,7 @@ jobs:
           format: markdown
           jobSummary: false
           lycheeVersion: v0.24.2
-          output: lychee-preview.md
+          output: lychee-rendered-html.md
           token: ${{ github.token }}
 
       - name: Save lychee cache