# 
name: execution gh-pages 
# 整个流程在master分支发生push事件时触发
on:
  push:
    branches:
      - main
jobs:
  build-and-deploy:
    runs-on: ubuntu-latest # 运行在ubuntu-latest环境的虚拟机中
    steps:
    # 获取仓库源码
    - name: Checkout
      uses: actions/checkout@v2
      with:
        persist-credentials: false
    # 构建和部署
    - name: build docs
      # 由于示例项目代码并非在根目录,所以要这里手动进入了项目目录
      # 如果你代码本身就处于根目录则不需要再手动进入了
      run: |
        npm install
        npm run docs:build
    # 发布
    - name: Deploy docs
      uses: JamesIves/github-pages-deploy-action@releases/v3
      # 环境变量
      with:
        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }} # GitHub 密钥 ACCESS_TOKEN 是在第二步Settings的Secrets中新增时定义的Name,要保持一致
        # 发布到指定分支
        BRANCH: gh-pages
        # 构建成果所在目录,默认位置都是在根目录
        FOLDER: ./docs-dist