diff --git a/.github/workflows/docs_pages.yml b/.github/workflows/docs_pages.yml new file mode 100644 index 0000000..528c79d --- /dev/null +++ b/.github/workflows/docs_pages.yml @@ -0,0 +1,66 @@ +name: Deploy Docs to GitHub Pages + +on: + # 在推送到 main 分支时触发 + push: + branches: + - main + # 允许手动触发 + workflow_dispatch: + +# 设置 GITHUB_TOKEN 的权限,允许部署到 GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# 只允许一个并发部署 +concurrency: + group: pages + cancel-in-progress: false + +jobs: + # 构建任务 + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 0 # 如果未启用 lastUpdated,则不需要 + + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: 20 + cache: npm + cache-dependency-path: docs/package-lock.json + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Install dependencies + run: npm ci + working-directory: docs + + - name: Build with VitePress + run: npm run docs:build + working-directory: docs + + - name: Upload artifact + uses: actions/upload-pages-artifact@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