feat: update docs and vitepress #12
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
| # https://v2.vuepress.vuejs.org/zh/guide/deployment.html#github-pages | |
| # https://github.com/crazy-max/ghaction-github-pages | |
| # https://github.com/pnpm/action-setup | |
| name: deploy-docs | |
| on: | |
| push: | |
| branches: | |
| - master | |
| paths-ignore: | |
| - '**/__tests__/**' | |
| - '**/TEST/**' | |
| - '**/TEST2/**' | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # “最近更新时间” 等 git 日志相关信息，需要拉取全部提交记录 | |
| fetch-depth: 0 | |
| - name: Install Node.js | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18 | |
| - uses: pnpm/action-setup@v2.0.1 | |
| name: Install pnpm | |
| id: pnpm-install | |
| with: | |
| version: 7 | |
| run_install: false | |
| - name: Get pnpm store directory | |
| id: pnpm-cache | |
| run: | | |
| echo "::set-output name=pnpm_cache_dir::$(pnpm store path)" | |
| - uses: actions/cache@v3 | |
| name: Setup pnpm cache | |
| with: | |
| path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }} | |
| key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pnpm-store- | |
| - name: Install dependencies | |
| run: pnpm install --no-frozen-lockfile | |
| # 运行构建脚本 | |
| - name: Build Vitepress site | |
| run: pnpm build | |
| # 查看 workflow 的文档来获取更多信息 | |
| # @see https://github.com/crazy-max/ghaction-github-pages | |
| - name: Deploy to GitHub Pages | |
| uses: crazy-max/ghaction-github-pages@v2 | |
| with: | |
| # 部署到 gh-pages 分支 | |
| target_branch: gh-pages | |
| # 部署目录为 VuePress 的默认输出目录 | |
| build_dir: .vitepress/dist | |
| fqdn: https://www.sysuke.com | |
| env: | |
| # @see https://docs.github.com/cn/actions/reference/authentication-in-a-workflow#about-the-github_token-secret | |
| GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }} |