fixup! feat(ci): add lychee broken link checker and stage-and-check job

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>

Author: skjnldsv

.github/workflows/sphinxbuild.yml

@@ -328,25 +328,18 @@ jobs:
           echo "Validation structure ready:"
           find full-context -type d -maxdepth 2
 
-      - name: Check for broken links with lychee
-        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
+      # ========================================================================
+      # UPLOAD VALIDATION CONTEXT FOR LINK CHECK JOB
+      # ========================================================================
+      # The full-context folder is uploaded so the link-check job (which runs
+      # in parallel with deploy) can download it and run lychee there.
+      # ========================================================================
+      - name: Upload full validation context
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
-          fail: true
-          token: ${{ secrets.GITHUB_TOKEN }}
-          jobSummary: true
-          args: |
-            --root-dir $(pwd)/full-context
-            --offline
-            --no-progress
-            --remap 'https://docs.nextcloud.com/server/ file://$(pwd)/full-context/server/'
-            --exclude 'mailto:'
-            --exclude '(https?:/?/?)?$'
-            --exclude-path '.*/404\.html'
-            'full-context/server/${{ steps.branch.outputs.branch_name }}/**/*.html'
-
-      - name: Clean up validation context
-        if: always()
-        run: rm -rf full-context
+          name: full-context
+          path: full-context/
+          retention-days: 1
 
       # ========================================================================
       # UPLOAD STAGING ARTIFACTS
@@ -361,6 +354,50 @@ jobs:
           path: stage/
           retention-days: 1
 
+  # ============================================================================
+  # LINK CHECK
+  # ============================================================================
+  # Runs in parallel with deploy. Downloads the full validation context
+  # prepared by stage-and-check, strips canonical links, then runs lychee.
+  # ============================================================================
+  link-check:
+    name: Check for broken links
+    needs: stage-and-check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download full validation context
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: full-context
+          path: full-context/
+
+      - name: Strip canonical HEAD link from validation HTML
+        run: |
+          find "full-context/server/${{ needs.stage-and-check.outputs.branch_name }}" -name '*.html' -print0 | while IFS= read -r -d '' f; do
+            perl -0pi -e 's{^\s*<link rel="canonical" href="https://docs\.nextcloud\.com/server/[^"]*" />\n}{}m' "$f"
+          done
+
+      - name: Check for broken links with lychee
+        uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
+        with:
+          fail: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          jobSummary: true
+          args: |
+            --root-dir $(pwd)/full-context
+            --offline
+            --no-progress
+            --remap 'https://docs.nextcloud.com/server/ file://$(pwd)/full-context/server/'
+            --exclude 'go\.php'
+            --exclude 'mailto:'
+            --exclude-path '.*/404\.html'
+            # Ignore version sidebar selector links 
+            --exclude '^file://.*/full-context/(latest|stable|[0-9]+)/(developer_manual|admin_manual|user_manual)/?$'
+            'full-context/server/${{ needs.stage-and-check.outputs.branch_name }}/user_manual/en/**/*.html'
+            'full-context/server/${{ needs.stage-and-check.outputs.branch_name }}/admin_manual/**/*.html'
+            'full-context/server/${{ needs.stage-and-check.outputs.branch_name }}/developer_manual/**/*.html'
+
   # ============================================================================
   # DEPLOY
   # ============================================================================
@@ -504,7 +541,7 @@ jobs:
           GH_TOKEN: ${{ secrets.COMMAND_BOT_PAT }}
 
   summary:
-    needs: [build-html, build-pdf, stage-and-check, deploy]
+    needs: [build-html, build-pdf, stage-and-check, link-check, deploy]
     runs-on: ubuntu-latest-low
     if: always()
 
@@ -518,10 +555,9 @@ jobs:
         run: |
           if ${{ github.event_name == 'pull_request' }}
           then
-            echo "This workflow ran for a pull request. We need build-html, build-pdf and stage-and-check to succeed, but deploy will be skipped"
-            if ${{ needs.build-html.result != 'success' || needs.build-pdf.result != 'success' || needs.stage-and-check.result != 'success' || needs.deploy.result != 'skipped' }}; then exit 1; fi
+            echo "This workflow ran for a pull request. We need build-html, build-pdf, stage-and-check and link-check to succeed, but deploy will be skipped"
+            if ${{ needs.build-html.result != 'success' || needs.build-pdf.result != 'success' || needs.stage-and-check.result != 'success' || needs.link-check.result != 'success' || needs.deploy.result != 'skipped' }}; then exit 1; fi
           else
             echo "This workflow ran for a push. We need all jobs to succeed, including deploy"
-            if ${{ needs.build-html.result != 'success' || needs.build-pdf.result != 'success' || needs.stage-and-check.result != 'success' || needs.deploy.result != 'success' }}; then exit 1; fi
+            if ${{ needs.build-html.result != 'success' || needs.build-pdf.result != 'success' || needs.stage-and-check.result != 'success' || needs.link-check.result != 'success' || needs.deploy.result != 'success' }}; then exit 1; fi
           fi
-