chore: 更新部署工作流，优化文档和示例项目的依赖版本同步

weilei · weilei · commit cecda5062ed2 · 2025-05-29T18:06:19.000+08:00
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -6,21 +6,21 @@ on:
     paths:
       - 'docs/**'
       - 'examples/**'
-      - 'packages/element-ui-x/package.json'
+      - 'packages/element-ui-x/**'
   pull_request:
     types: [opened, synchronize, reopened]
     branches: [master]
     paths:
       - 'docs/**'
       - 'examples/**'
-      - 'packages/element-ui-x/package.json'
+      - 'packages/element-ui-x/**'
   pull_request_target:
     types: [closed]
     branches: [master]
     paths:
       - 'docs/**'
       - 'examples/**'
-      - 'packages/element-ui-x/package.json'
+      - 'packages/element-ui-x/**'
   workflow_dispatch:
     inputs:
       deploy_target:
@@ -34,22 +34,16 @@ on:
           - examples
 
 jobs:
-  sync-version:
-    name: 同步版本号
+  deploy-docs:
+    name: 部署文档站
+    if: ${{ github.event_name != 'workflow_dispatch' || github.event.inputs.deploy_target == 'all' || github.event.inputs.deploy_target == 'docs' }}
     runs-on: ubuntu-latest
-    if: |
-      (github.event_name == 'push' && contains(github.event.head_commit.modified, 'packages/element-ui-x/package.json')) ||
-      github.event_name == 'workflow_dispatch'
-    outputs:
-      version-changed: ${{ steps.check-version.outputs.changed }}
-      new-version: ${{ steps.check-version.outputs.version }}
+    env:
+      VUEPRESS_GA_ID: ${{ secrets.VUEPRESS_GA_ID }}
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          fetch-depth: 0
 
       - name: Configure Git
         run: |
@@ -61,78 +55,55 @@ jobs:
         with:
           node-version: '16'
 
-      - name: Check and sync version
-        id: check-version
+      - name: Get package version and replace dependencies
+        id: version-setup
         run: |
+          # 获取主包版本号
           MAIN_VERSION=$(node -p "require('./packages/element-ui-x/package.json').version")
           echo "Main package version: $MAIN_VERSION"
+          echo "version=$MAIN_VERSION" >> $GITHUB_OUTPUT
 
-          DOCS_VERSION=$(node -p "require('./docs/package.json').dependencies['vue-element-ui-x']" | sed 's/[\^~]//g')
-          echo "Docs package version: $DOCS_VERSION"
+          # 备份原始的package.json文件
+          cp docs/package.json docs/package.json.backup
 
-          if [ "$MAIN_VERSION" != "$DOCS_VERSION" ]; then
-            echo "Version mismatch detected, syncing..."
+          # 临时替换文档站点的依赖为NPM版本
+          echo "Replacing docs package.json dependency..."
+          node -e "
+            const fs = require('fs');
+            const docsPackage = JSON.parse(fs.readFileSync('docs/package.json', 'utf8'));
             
-            node -e "
-              const fs = require('fs');
-              const docsPackage = JSON.parse(fs.readFileSync('docs/package.json', 'utf8'));
+            // 检查是否使用本地依赖
+            if (docsPackage.dependencies['vue-element-ui-x'].startsWith('file:')) {
+              console.log('Found local dependency, replacing with NPM version...');
               docsPackage.dependencies['vue-element-ui-x'] = '^$MAIN_VERSION';
               fs.writeFileSync('docs/package.json', JSON.stringify(docsPackage, null, 2) + '\n');
-              console.log('Updated docs package.json to version ^$MAIN_VERSION');
-            "
-            
-            git add docs/package.json
-            git commit -m "docs: sync vue-element-ui-x version to ^$MAIN_VERSION" || echo "No changes to commit"
-            git push origin ${{ github.ref_name }} || echo "Nothing to push"
-            
-            echo "changed=true" >> $GITHUB_OUTPUT
-            echo "version=$MAIN_VERSION" >> $GITHUB_OUTPUT
-          else
-            echo "Versions are already in sync"
-            echo "changed=false" >> $GITHUB_OUTPUT
-            echo "version=$MAIN_VERSION" >> $GITHUB_OUTPUT
-          fi
-
-  deploy-docs:
-    name: 部署文档站
-    needs: [sync-version]
-    if: |
-      always() && 
-      (needs.sync-version.result == 'success' || needs.sync-version.result == 'skipped') &&
-      (${{ github.event_name != 'workflow_dispatch' || github.event.inputs.deploy_target == 'all' || github.event.inputs.deploy_target == 'docs' }})
-    runs-on: ubuntu-latest
-    env:
-      VUEPRESS_GA_ID: ${{ secrets.VUEPRESS_GA_ID }}
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-        with:
-          ref: ${{ github.ref }}
-
-      - name: Pull latest changes
-        if: needs.sync-version.outputs.version-changed == 'true'
-        run: git pull origin ${{ github.ref_name }}
-
-      - name: Configure Git
-        run: |
-          git config --global user.name "GitHub Actions"
-          git config --global user.email "github-actions@github.com"
+              console.log('Replaced with version: ^$MAIN_VERSION');
+            } else {
+              console.log('Already using NPM version');
+            }
+          "
 
-      - name: Setup Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: '16'
+          # 显示修改后的依赖
+          echo "Updated docs dependency:"
+          node -p "require('./docs/package.json').dependencies['vue-element-ui-x']"
 
-      - name: Install dependencies
+      - name: Install docs dependencies
         working-directory: docs
         run: |
+          echo "Installing dependencies with NPM version..."
           npm install
 
       - name: Build documentation
         working-directory: docs
         run: npm run build
 
+      - name: Restore original package.json
+        run: |
+          echo "Restoring original docs package.json..."
+          mv docs/package.json.backup docs/package.json
+          echo "Restored to:"
+          node -p "require('./docs/package.json').dependencies['vue-element-ui-x']"
+
       - name: Deploy to Vercel
         id: deploy-docs
         uses: amondnet/vercel-action@v25
@@ -148,15 +119,11 @@ jobs:
         uses: actions/github-script@v6
         with:
           script: |
-            let body = '📖 文档预览: ${{ steps.deploy-docs.outputs.preview-url }}';
-            if ('${{ needs.sync-version.outputs.version-changed }}' === 'true') {
-              body += '\n🔄 已自动同步版本号到: ${{ needs.sync-version.outputs.new-version }}';
-            }
             github.rest.issues.createComment({
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: body
+              body: '📖 文档预览: ${{ steps.deploy-docs.outputs.preview-url }}\n🔄 使用NPM版本: ${{ steps.version-setup.outputs.version }}'
             })
 
   deploy-examples:
@@ -175,15 +142,55 @@ jobs:
         with:
           node-version: '16'
 
+      - name: Get package version and replace dependencies
+        id: version-setup
+        run: |
+          # 获取主包版本号
+          MAIN_VERSION=$(node -p "require('./packages/element-ui-x/package.json').version")
+          echo "Main package version: $MAIN_VERSION"
+          echo "version=$MAIN_VERSION" >> $GITHUB_OUTPUT
+
+          # 备份原始的package.json文件
+          cp examples/package.json examples/package.json.backup
+
+          # 临时替换示例项目的依赖为NPM版本
+          echo "Replacing examples package.json dependency..."
+          node -e "
+            const fs = require('fs');
+            const examplesPackage = JSON.parse(fs.readFileSync('examples/package.json', 'utf8'));
+            
+            // 检查是否使用本地依赖
+            if (examplesPackage.dependencies['vue-element-ui-x'].startsWith('file:')) {
+              console.log('Found local dependency, replacing with NPM version...');
+              examplesPackage.dependencies['vue-element-ui-x'] = '^$MAIN_VERSION';
+              fs.writeFileSync('examples/package.json', JSON.stringify(examplesPackage, null, 2) + '\n');
+              console.log('Replaced with version: ^$MAIN_VERSION');
+            } else {
+              console.log('Already using NPM version');
+            }
+          "
+
+          # 显示修改后的依赖
+          echo "Updated examples dependency:"
+          node -p "require('./examples/package.json').dependencies['vue-element-ui-x']"
+
       - name: Install dependencies
         working-directory: examples
         run: |
+          echo "Installing dependencies with NPM version..."
           npm install
 
       - name: Build
         working-directory: examples
         run: npm run build
 
+      - name: Restore original package.json
+        run: |
+          echo "Restoring original examples package.json..."
+          mv examples/package.json.backup examples/package.json
+          echo "Restored to:"
+          node -p "require('./examples/package.json').dependencies['vue-element-ui-x']"
+
       - name: Deploy to Vercel
         id: deploy-examples
         uses: amondnet/vercel-action@v25
@@ -203,5 +210,5 @@ jobs:
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              body: '🚀 示例预览: ${{ steps.deploy-examples.outputs.preview-url }}'
+              body: '🚀 示例预览: ${{ steps.deploy-examples.outputs.preview-url }}\n🔄 使用NPM版本: ${{ steps.version-setup.outputs.version }}'
             })
