feat: 新增api document #5
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
name: Deploy Docs to Docs Branch | |
on: | |
push: | |
branches: | |
- dev # 目前主分支是dev | |
jobs: | |
build-and-deploy-docs: | |
runs-on: ubuntu-latest | |
steps: | |
# 1. 检出代码 | |
- name: Checkout Code | |
uses: actions/checkout@v3 | |
# 2. 安装依赖 | |
- name: Install Dependencies | |
run: npm install | |
# 3. 生成 API 文档 | |
- name: Build API Documentation | |
run: npm run docs | |
- name: Commit files | |
run: | | |
cd docs | |
git init | |
git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
git config --local user.name "github-actions[bot]" | |
git add . | |
git commit -m "Update API documentation" | |
git status | |
# 4. 部署到 docs 分支 | |
- name: Deploy Docs to Docs Branch | |
uses: ad-m/github-push-action@master | |
with: | |
branch: docs | |
directory: docs | |
force: true |