From b92a06a4684e379bbf8d271607f68dfbc1bc5b06 Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Thu, 7 May 2026 16:05:59 +0800 Subject: [PATCH] Update deployment workflow and enhance documentation build process --- .github/workflows/vitepress-deploy.yml | 35 +++++++++++--------------- package.json | 2 +- 2 files changed, 16 insertions(+), 21 deletions(-) diff --git a/.github/workflows/vitepress-deploy.yml b/.github/workflows/vitepress-deploy.yml index 25698980..515cf1d6 100644 --- a/.github/workflows/vitepress-deploy.yml +++ b/.github/workflows/vitepress-deploy.yml @@ -1,8 +1,16 @@ -name: Docs Auto Deploy +name: Docs build test and auto deploy on: + pull_request: + branches: [ "v3" ] + types: [ opened, synchronize, reopened ] + paths: + - 'config/**.yml' + - 'docs/**' + - 'package.json' + - 'yarn.lock' + - '.github/workflows/vitepress-deploy.yml' push: - branches: - - v3 + branches: [ "v3" ] paths: - 'config/**.yml' - 'docs/**' @@ -20,15 +28,8 @@ jobs: uses: actions/checkout@v4 - uses: actions/setup-node@v3 - with: - cache: yarn - - run: yarn install --frozen-lockfile - - - name: "Copy Config Files" - run: | - mkdir -p docs/.vitepress/config - cp -r config/* docs/.vitepress/config/ + - run: npm install - name: "Install PHP for official runners" uses: shivammathur/setup-php@v2 @@ -55,19 +56,13 @@ jobs: - name: "Install Locked Dependencies" run: "composer install --no-interaction --no-progress" - # TODO: Uncomment when v3 gen commands are implemented - # - name: "Generate Extension Support List" - # run: | - # bin/spc dev:gen-ext-docs > docs/en/guide/extensions.md - # bin/spc dev:gen-ext-docs > docs/zh/guide/extensions.md - # bin/spc dev:gen-ext-dep-docs > docs/en/guide/deps-map.md - # bin/spc dev:gen-ext-dep-docs > docs/zh/guide/deps-map.md - - name: Build - run: yarn docs:build + run: npm run docs:build + # Deploy to GitHub Pages only when the workflow is triggered by a push to the v3 branch - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 + if: github.event_name == 'push' && github.ref == 'refs/heads/v3' with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: docs/.vitepress/dist diff --git a/package.json b/package.json index 59011a01..7e88c2d1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "scripts": { - "docs:dev": "vitepress dev docs", + "docs:dev": "node docs/.vitepress/gen-meta.js && vitepress dev docs", "docs:gen-meta": "node docs/.vitepress/gen-meta.js", "docs:build": "npm run docs:gen-meta && vitepress build docs", "docs:preview": "vitepress preview docs"