This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 构建 VitePress 站点并将其部署到 GitHub Pages 的示例工作流程 | |
| # | |
| name: Deploy VitePress site to Pages | |
| on: | |
| # 在针对 main 分支的推送上运行。 | |
| # 如果你使用 master 分支作为默认分支，请将其更改为 master | |
| push: | |
| branches: [main, master] | |
| # 允许你从 Actions 选项卡手动运行此工作流程 | |
| 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 pnpm | |
| uses: pnpm/action-setup@v4 # 安装pnpm并添加到环境变量 | |
| with: | |
| version: 8.6.12 # 指定需要的pnpm版本，或使用最新版本 | |
| - name: Setup Node | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18 # 指定Node.js版本 | |
| cache: pnpm # npm / pnpm / yarn | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v5 # 在工作流程自动配置GithubPages | |
| - name: Install dependencies | |
| run: pnpm install # npm ci / pnpm install / yarn install / bun install | |
| - name: Build with VitePress | |
| run: pnpm docs:build # npm run docs:build / pnpm docs:build / yarn docs:build / bun run docs:build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: .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 |