feat: deploy docs via Zephyr Cloud with PR preview environments

.github/workflows/ci.yml

@@ -8,10 +8,6 @@ on:
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-permissions:
-  pages: write
-  id-token: write
-
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
@@ -73,10 +69,6 @@ jobs:
     runs-on: ubuntu-latest
     name: Deploy Docs
 
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-
     steps:
       - name: Checkout
         uses: actions/checkout@v6
@@ -102,13 +94,6 @@ jobs:
             ${{ runner.os }}-turbo-
 
       - name: Build docs
+        env:
+          ZE_CI_TOKEN: ${{ secrets.ZE_CI_TOKEN }}
         run: pnpm turbo build -F @kitajs/docs-html
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v4
-        with:
-          path: packages/docs/dist
-
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v5

.github/workflows/preview-environments.yml

@@ -0,0 +1,53 @@
+name: Zephyr Preview Environments
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+
+permissions:
+  contents: read
+  pull-requests: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  preview:
+    runs-on: ubuntu-latest
+    name: Preview Docs
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Setup node and restore cached dependencies
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'pnpm'
+
+      - name: Install packages
+        run: pnpm install --frozen-lockfile
+
+      - name: Cache turbo build setup
+        uses: actions/cache@v5
+        with:
+          path: .turbo
+          key: ${{ runner.os }}-turbo-${{ github.sha }}
+          restore-keys: |
+            ${{ runner.os }}-turbo-
+
+      - name: Build docs
+        if: ${{ github.event.action != 'closed' }}
+        env:
+          ZE_CI_TOKEN: ${{ secrets.ZE_CI_TOKEN }}
+        run: pnpm turbo build -F @kitajs/docs-html
+
+      - name: Zephyr Preview Environments
+        uses: ZephyrCloudIO/zephyr-preview-environment-action@v0.2.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}

packages/docs/package.json

@@ -35,6 +35,7 @@
     "shiki": "^4.0.2",
     "typescript": "catalog:",
     "unified": "^11.0.5",
-    "unist-util-visit": "^5.1.0"
+    "unist-util-visit": "^5.1.0",
+    "zephyr-rspress-plugin": "^1.1.2"
   }
 }

packages/docs/rspress.config.ts

@@ -20,6 +20,7 @@ import pluginFileTree from 'rspress-plugin-file-tree'
 import pluginOg from 'rspress-plugin-og'
 import readingTime from 'rspress-plugin-reading-time'
 import ts from 'typescript'
+import { withZephyr } from 'zephyr-rspress-plugin'
 import { remarkKitaPlugin } from './plugins/kita/remarkPlugin'
 
 /** Shared TypeDoc setup for compact, public-only API docs. */
@@ -64,6 +65,7 @@ export default defineConfig({
   },
 
   plugins: [
+    withZephyr(),
     readingTime(),
     pluginTwoslash({
       twoslashOptions: {