Merge pull request #3001 from davidgamero/ci/docs-native-pages-deploy

Ci/docs native pages deploy

Author: kubernetes-prow[bot]

.github/workflows/deploy-docs.yml

@@ -1,22 +1,30 @@
-name: Build and Deploy Docs
+name: Deploy Docs
 on:
     push:
         branches:
             - main
-        paths:
-            - 'src/**'
-            - 'typedoc.json'
-            - 'package.json'
-            - 'package-lock.json'
-            - '.github/workflows/deploy-docs.yml'
+    # Allow re-publishing on demand, e.g. after a failed deploy or a Pages
+    # settings change, without pushing an empty commit to main.
+    workflow_dispatch:
 
 permissions: {}
 
+# Allow one concurrent deployment; queue rather than cancel so an in-flight
+# Pages deployment is never left half-applied.
+concurrency:
+    group: pages
+    cancel-in-progress: false
+
 jobs:
-    build-and-deploy-docs:
+    build:
+        # workflow_dispatch can be triggered from any ref, and the ref chosen is
+        # what would get published. Only ever publish main. The push trigger is
+        # already main-only, so this guard applies solely to manual runs.
+        # `deploy` needs `build`, so skipping here skips the whole workflow.
+        if: github.ref == 'refs/heads/main'
         runs-on: ubuntu-latest
         permissions:
-            contents: write
+            contents: read
         steps:
             - name: Checkout
               uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
@@ -26,17 +34,31 @@ jobs:
               uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
               with:
                   node-version: '22'
-            # Pre-check to validate that versions match between package.json
-            # and package-lock.json. Needs to run before npm install
-            - name: Validate package.json and package-lock.json versions
-              run: node version-check.js
-            - name: Install dependencies
+            # Root deps are required: docusaurus-plugin-typedoc reads ../src/*.ts
+            # and needs the root dependency types to resolve.
+            - name: Install root dependencies
+              run: npm ci
+            - name: Install docs dependencies
               run: npm ci
+              working-directory: docs
             - name: Build docs
-              run: npm run docs
-
-            - name: Deploy docs
-              uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
+              run: npm run build
+              working-directory: docs
+            - name: Upload Pages artifact
+              uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
               with:
-                  branch: gh-pages # The branch the action should deploy to.
-                  folder: docs # The folder the action should deploy.
+                  path: docs/build
+
+    deploy:
+        needs: build
+        runs-on: ubuntu-latest
+        permissions:
+            pages: write
+            id-token: write
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        steps:
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

.github/workflows/deploy-docs-v2.yml .github/workflows/docs-build.yml.github/workflows/deploy-docs-v2.yml renamed to .github/workflows/docs-build.yml

@@ -1,23 +1,32 @@
-name: Build and Deploy Docs v2
+name: Docs Build and Test
 on:
-    push:
-        branches:
-            - main
     pull_request:
         branches:
             - main
-permissions:
-    contents: write
+
+permissions: {}
+
+# Stale runs for a PR are worthless once a new commit lands.
+concurrency:
+    group: docs-build-${{ github.ref }}
+    cancel-in-progress: true
+
 jobs:
-    build-and-deploy-docs:
+    build:
         runs-on: ubuntu-latest
+        permissions:
+            contents: read
         steps:
             - name: Checkout
               uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+              with:
+                  persist-credentials: false
             - name: Setup Node.js
               uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
               with:
-                  node-version: '20'
+                  node-version: '22'
+            # Root deps are required: docusaurus-plugin-typedoc reads ../src/*.ts
+            # and needs the root dependency types to resolve.
             - name: Install root dependencies
               run: npm ci
             - name: Install docs dependencies
@@ -36,9 +45,3 @@ jobs:
                   mkdir -p _linkcheck/javascript
                   cp -R docs/build/. _linkcheck/javascript/
                   npx @untitaker/hyperlink _linkcheck --check-anchors
-            - name: Deploy to gh-pages
-              if: github.event_name == 'push'
-              uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
-              with:
-                  branch: gh-pages
-                  folder: docs/build