Merge pull request #3 from volcengine/feat/deploy-docs

feat(ci): support vitepress deployment on github pages

Author: YumengBao

.github/workflow/deploy-docs.yaml

@@ -3,69 +3,54 @@
 name: Deploy VitePress site to Pages
 
 on:
-  # 在针对 `main` 分支的推送上运行。如果你
-  # 使用 `master` 分支作为默认分支，请将其更改为 `master`
   push:
     branches:
       - main
       - feat/docs
     paths:
       - 'docs/**'
-      - '.github/workflows/deploy-docs.yaml'
+      - '.github/workflows/deploy-docs.yml'
 
   # 允许你从 Actions 选项卡手动运行此工作流程
   workflow_dispatch:
 
-# 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages
 permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列
-# 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成
-concurrency:
-  group: pages
-  cancel-in-progress: false
+  contents: write
 
 jobs:
-  # 构建工作
-  build:
+  build-and-deploy:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v5
         with:
-          fetch-depth: 0 # 如果未启用 lastUpdated，则不需要
-      # - uses: pnpm/action-setup@v4 # 如果使用 pnpm，请取消此区域注释
-      #   with:
-      #     version: 9
-      # - uses: oven-sh/setup-bun@v1 # 如果使用 Bun，请取消注释
+          fetch-depth: 0
+
       - name: Setup Node
         uses: actions/setup-node@v6
         with:
-          node-version: 24
-          cache: npm # 或 pnpm / yarn
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
+          node-version: '22'
+
       - name: Install dependencies
-        run: npm ci # 或 pnpm install / yarn install / bun install
+        run: |
+          cd docs
+          echo "Check current directory"
+          pwd
+          npm ci
+
       - name: Build with VitePress
-        run: npm run docs:build # 或 pnpm docs:build / yarn docs:build / bun run docs:build
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        run: |
+          cd docs
+          echo "Check current directory"
+          pwd
+          npm run docs:build
+          
+      - name: Deploy to feat/deploy
+        uses: peaceiris/actions-gh-pages@v3
         with:
-          path: docs/.vitepress/dist
-
-  # 部署工作
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    needs: build
-    runs-on: ubuntu-latest
-    name: Deploy
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4
+          github_token: ${{ secrets.REPO_TOKEN }}
+          publish_dir: docs/.vitepress/dist
+          publish_branch: feat/deploy
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+          commit_message: 'Deploy docs to feat/deploy'

.github/workflows/deploy-docs.yml

@@ -167,8 +167,6 @@ cython_debug/
 uv.lock
 
 # VitePress related files (security concern - keep Markdown docs in repo)
-
-docs/package-lock.json
 docs/node_modules/
 
 # local test files