GitHub Action部署工作流未自动触发问题及优化方案咨询

当前deploy工作流无法自动触发的原因 #

你的deploy.yml配置存在以下几个关键遗漏：

• 未限定build工作流的成功状态：workflow_run的types: [completed]会包含build失败的情况，需要明确只在build成功时执行deploy。
• 未关联触发build的分支上下文：workflow_run触发的deploy无法直接获取原推送分支的信息，需要通过上下文提取分支来匹配对应部署环境。
• 缺少artifact下载逻辑：deploy工作流需要先下载build生成的产物，否则没有可部署的内容。

修正后的deploy.yml配置 #

name: deploy

on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Environment'
        required: true
        default: 'stage'
        options:
          - dev
          - stage
          - prod
      ref:
        description: 'Git ref to deploy (branch/tag)'
        required: false
  workflow_run:
    workflows: ["build"]
    types:
      - completed
    branches:
      - main
      - 'feature/**' # 根据你的功能分支命名规则调整

jobs:
  deploy:
    runs-on: ubuntu-latest
    # 仅在build工作流成功时执行
    if: ${{ github.event.workflow_run.conclusion == 'success' }}
    steps:
      # 下载build生成的artifact
      - name: Download build artifact
        uses: actions/download-artifact@v3
        with:
          run-id: ${{ github.event.workflow_run.id }}
          name: artifact # 需和build.yml里upload-artifact的name一致

      # 提取分支信息，自动匹配部署环境
      - name: Determine target environment
        id: set-env
        run: |
          if [[ "${{ github.event_name }}" == "workflow_run" ]]; then
            BRANCH=$(echo "${{ github.event.workflow_run.head_branch }}" | tr '[:upper:]' '[:lower:]')
            if [[ "$BRANCH" == "main" ]]; then
              echo "environment=stage" >> $GITHUB_OUTPUT
            elif [[ "$BRANCH" == feature/* ]]; then
              echo "environment=dev" >> $GITHUB_OUTPUT
            fi
          else
            echo "environment=${{ github.event.inputs.environment }}" >> $GITHUB_OUTPUT
          fi

      # 执行部署逻辑，替换为你的实际部署命令
      - name: Deploy to ${{ steps.set-env.outputs.environment }}
        run: |
          echo "Deploying to ${{ steps.set-env.outputs.environment }} environment"
          # 示例：kubectl apply -f ./dist/deploy.yaml 或 scp ./dist/* user@server:/path

其他实现思路 #

思路1：合并build与deploy为单工作流 #

将构建和部署逻辑放在同一个工作流中，通过分支条件自动选择环境，同时保留手动触发选项：

name: build-and-deploy

on:
  push:
    branches:
      - main
      - 'feature/**'
  workflow_dispatch:
    inputs:
      environment:
        description: 'Environment'
        required: true
        default: 'stage'
        options:
          - dev
          - stage
          - prod

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Build frontend
        run: # 你的构建命令，如 npm run build
      - name: Save artifact
        uses: actions/upload-artifact@v3
        with:
          name: frontend-build
          path: dist/ # 你的产物目录

  deploy:
    needs: build
    runs-on: ubuntu-latest
    steps:
      - name: Download artifact
        uses: actions/download-artifact@v3
        with:
          name: frontend-build
      - name: Set target environment
        id: set-env
        run: |
          if [[ "${{ github.event_name }}" == "push" ]]; then
            BRANCH="${{ github.ref_name }}"
            if [[ "$BRANCH" == "main" ]]; then
              echo "environment=stage" >> $GITHUB_OUTPUT
            elif [[ "$BRANCH" == feature/* ]]; then
              echo "environment=dev" >> $GITHUB_OUTPUT
            fi
          else
            echo "environment=${{ github.event.inputs.environment }}" >> $GITHUB_OUTPUT
          fi
      - name: Deploy
        run: # 你的部署命令

思路2：使用可复用工作流 #

将build和deploy分别封装为可复用工作流，提升维护性和复用性：

1. 创建.github/workflows/reusable-build.yml：

name: Reusable Build
on:
  workflow_call:

jobs:
  build:
    runs-on: ubuntu-latest
    outputs:
      artifact-name: frontend-build
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Build frontend
        run: # 构建命令
      - name: Upload artifact
        uses: actions/upload-artifact@v3
        with:
          name: frontend-build
          path: dist/

2. 创建.github/workflows/reusable-deploy.yml：

name: Reusable Deploy
on:
  workflow_call:
    inputs:
      environment:
        required: true
        type: string
      artifact-name:
        required: true
        type: string

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Download artifact
        uses: actions/download-artifact@v3
        with:
          name: ${{ inputs.artifact-name }}
      - name: Deploy to ${{ inputs.environment }}
        run: # 部署命令

3. 主工作流调用：

name: Main Workflow
on:
  push:
    branches: [main, feature/**]
  workflow_dispatch:
    inputs:
      environment:
        required: true
        default: stage
        options: [dev, stage, prod]

jobs:
  build:
    uses: ./.github/workflows/reusable-build.yml
  deploy:
    needs: build
    uses: ./.github/workflows/reusable-deploy.yml
    with:
      environment: ${{ github.event_name == 'push' && (github.ref_name == 'main' && 'stage' || 'dev') || github.event.inputs.environment }}
      artifact-name: ${{ jobs.build.outputs.artifact-name }}

内容的提问来源于stack exchange，提问作者ilj