This file contains 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: [master] | |
| # 允许你从 Actions 选项卡手动运行此工作流程 | |
| workflow_dispatch: | |
| # 设置 GITHUB_TOKEN 的权限，以允许部署到 GitHub Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| # 只允许同时进行一次部署，跳过正在运行和最新队列之间的运行队列 | |
| # 但是，不要取消正在进行的运行，因为我们希望允许这些生产部署完成 | |
| concurrency: | |
| group: pages | |
| cancel-in-progress: false | |
| jobs: | |
| # 构建工作 | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| # 使用actions/checkout@v4 库拉取代码到 ubuntu 上 | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| # 根据网上资料查询此处可以设置为 false。https://github.com/actions/checkout | |
| persist-credentials: false | |
| # 安装 pnpm | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@v2 | |
| with: | |
| version: 8 | |
| # 设置node的版本 | |
| - name: Use Node.js | |
| # 使用 actions/setup-node@v3 库安装 nodejs，with 提供了一个参数 node-version 表示要安装的 nodejs 版本 | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: '18.x' | |
| cache: 'pnpm' | |
| # 打包成静态文件 | |
| - name: Build | |
| run: pnpm install && pnpm build | |
| # 部署到GitHub Pages - 也就是将打包内容发布到GitHub Pages | |
| - name: Deploy | |
| # 使用别人写好的 actions去部署（将打包文件部署到指定分支上） | |
| uses: JamesIves/github-pages-deploy-action@v4.3.3 | |
| # 自定义环境变量 | |
| with: | |
| # 指定仓库：你要发布的仓库路径名 | |
| repository-name: heygsc/hello | |
| # 部署到 deploy-pages 分支，也就是部署后提交到那个分支 | |
| branch: master | |
| # 填写打包好的目录名称路径，本项目配置在根目录 | |
| folder: docs/.vitepress/dist |