deploy-docs.yml

name: deploy docs
# 指定在什么情况下会运行
on:
  # 在指定的分支发生变化的时候运行
  push:
    branches:
      - source
    paths:
      - ".github/workflows/deploy-docs.yml"
      - "my-docs/**"
      - "docusaurus.config.ts"
      - "src/**"
      - "package.json"
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 部署到 GitHub Pages 时 GITHUB_TOKEN 的权限
permissions:
  contents: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          ref: source

      - name: Setup Node
        uses: actions/setup-node@v4
        with:
          node-version: 20

      - name: Install pnpm
        run: npm i -g pnpm

      - name: Install dependencies
        run: pnpm i --frozen-lockfile

      - name: Build doc
        run: pnpm build

      - name: Deploy Doc 🚀
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: github-pages
          folder: ./build
          clean: false

      - name: Deploy Doc 🚀
        uses: actions/upload-pages-artifact@v3
        with:
          path: build

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    permissions:
      pages: write
      id-token: write
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4