diff --git a/.github/workflows/auto-build-main-module-docs.yml b/.github/workflows/auto-build-main-module-docs.yml new file mode 100644 index 0000000000..1828c2585a --- /dev/null +++ b/.github/workflows/auto-build-main-module-docs.yml @@ -0,0 +1,72 @@ +name: Auto Build Main Module Docs + +on: + pull_request: + branches: [develop] + paths: + - 'docs/**' + push: + branches: [develop] + paths: + - 'docs/**' + +jobs: + verify-main-build: + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + + steps: + - uses: webfactory/ssh-agent@v0.8.0 + with: + ssh-private-key: ${{ secrets.SUBMODULE_SSH_KEY_PRIVATE }} + - name: Checkout submodule repo + uses: actions/checkout@v4 + with: + fetch-depth: 0 + token: ${{ secrets.PAT_TOKEN }} + + - name: Checkout main repository + run: | + # 克隆主仓库 + git clone https://github.com/opentiny/docs.git docs-main + cd docs-main + + # 更新子模块到PR分支的版本 + git submodule sync --recursive + git submodule update --init --recursive + + + # 获取PR分支的最新提交 + cd ./tiny-engine + BRANCH_NAME="${{ github.head_ref }}" + git fetch origin $BRANCH_NAME + git checkout $BRANCH_NAME + + # 回到主仓库根目录 + cd ../ + + - name: Setup pnpm + uses: pnpm/action-setup@v3 + with: + version: 9 + + - name: Run main repo build + id: build + working-directory: ./docs-main + run: | + pnpm i + # 如果使用VitePress + pnpm build + + - name: Update PR status + if: always() + run: | + # 检查构建是否成功 + if [ ${{ steps.build.outcome }} == 'success' ]; then + echo "✅ 主仓库构建成功" + else + echo "❌ 主仓库构建失败" + exit 1 + fi diff --git a/.github/workflows/auto-deploy-docs.yml b/.github/workflows/auto-deploy-docs.yml new file mode 100644 index 0000000000..2a27432188 --- /dev/null +++ b/.github/workflows/auto-deploy-docs.yml @@ -0,0 +1,21 @@ +name: Auto Deploy Docs + +on: + push: + branches: [develop] + paths: + - 'docs/**' + +jobs: + notify: + runs-on: ubuntu-latest + steps: + - name: Trigger main repo workflow + env: + PAT: ${{ secrets.PAT_TOKEN }} + run: | + curl -X POST \ + -H "Authorization: token $PAT" \ + -H "Accept: application/vnd.github.v3+json" \ + https://api.github.com/repos/opentiny/docs/dispatches \ + -d '{"event_type":"submodule-updated"}' \ No newline at end of file diff --git a/docs/api/api-overview.md b/docs/api/api-overview.md index d62cd217b9..093fcfa4be 100644 --- a/docs/api/api-overview.md +++ b/docs/api/api-overview.md @@ -2,7 +2,7 @@ TinyEngine的API主要分为`TinyEngine能力API`和`开源后端接口API`。 -## TinyEngine能力API +## TinyEngine 能力API 主要提供以下几类API - 主包API - 画布API