Update docs release strategy (#1118)

Author: ecraig12345

.github/workflows/docsite.yml

@@ -0,0 +1,58 @@
+name: Update documentation site
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'docs/**'
+      - .github/workflows/docsite.yml
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+
+permissions: {}
+
+jobs:
+  docs:
+    name: Update docs
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
+
+      # The docs have a separate installation using Node 22 due to needing newer dependencies
+      - name: Install Node.js
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
+        with:
+          node-version-file: docs/.nvmrc
+
+      - run: yarn --immutable
+        working-directory: ./docs
+
+      - run: yarn docs:build
+        working-directory: ./docs
+
+      - name: Upload site as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4
+        with:
+          path: docs/.vuepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: docs
+    permissions:
+      # to deploy to Pages
+      pages: write
+      # to verify the deployment originates from an appropriate source
+      id-token: write
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4

.github/workflows/release.yml

@@ -7,6 +7,9 @@ on:
 env:
   npmVersion: 8
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+
 permissions: {}
 
 jobs:
@@ -59,48 +62,3 @@ jobs:
         env:
           NPM_AUTHTOKEN: ${{ secrets.NPM_AUTHTOKEN }}
           REPO_PAT: ${{ secrets.REPO_PAT }}
-
-  # The docs have a separate installation using Node 20 due to needing newer dependencies
-  docs:
-    name: Update docs
-
-    needs: build
-
-    runs-on: ubuntu-latest
-
-    permissions:
-      # Needed by gh-pages publish
-      contents: write
-
-    steps:
-      - name: Check out code
-        uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
-        with:
-          # Don't save creds in the git config (so it's easier to override later)
-          persist-credentials: false
-
-      - name: Install Node.js 20
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
-        with:
-          cache: yarn
-          node-version: 20
-
-      - run: yarn --immutable
-        working-directory: ./docs
-
-      - run: yarn docs:build
-        working-directory: ./docs
-
-      - name: Update docs
-        run: |
-          git config user.email "kchau@microsoft.com"
-          git config user.name "Ken Chau"
-
-          # See previous step for explanation
-          trap "git remote set-url origin '$(git remote get-url origin)'" EXIT
-          git remote set-url origin "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$GITHUB_REPOSITORY.git"
-
-          yarn release:docs
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        working-directory: ./docs

docs/.vuepress/client.js docs/.vuepress/client.tsdocs/.vuepress/client.js renamed to docs/.vuepress/client.ts

@@ -6,19 +6,21 @@
   "type": "module",
   "scripts": {
     "docs": "vuepress dev --host localhost",
-    "docs:build": "vuepress build",
-    "release:docs": "yarn docs:build && yarn gh-pages -d .vuepress/dist --dotfiles"
+    "docs:build": "vuepress build"
   },
   "devDependencies": {
+    "@types/node": "^22.0.0",
     "@vuepress/bundler-vite": "^2.0.0-rc.18",
     "@vuepress/plugin-markdown-chart": "^2.0.0-rc.109",
     "@vuepress/plugin-search": "^2.0.0-rc.61",
     "@vuepress/theme-default": "^2.0.0-rc",
-    "gh-pages": "^6.0.0",
     "mermaid": "^11.4.0",
     "sass-embedded": "^1.81.0",
     "vuepress": "^2.0.0-rc"
   },
+  "resolutions": {
+    "@types/node@npm:*": "^22.0.0"
+  },
   "engines": {
     "node": ">=22",
     "yarn": "^4"

docs/.vuepress/config.js docs/.vuepress/config.tsdocs/.vuepress/config.js renamed to docs/.vuepress/config.ts

@@ -1,13 +1,11 @@
 {
   "compilerOptions": {
     "noEmit": true,
-    "allowJs": true,
-    "checkJs": true,
     "strict": true,
     "lib": ["es2022", "dom"],
     "module": "es2022",
     "moduleResolution": "bundler",
-    "types": []
+    "types": ["node"]
   },
-  "include": ["./.vuepress/*.js"]
+  "include": ["./.vuepress/*"]
 }