如何在GitHub Actions中手动跳过生产部署且不触发失败状态

以下是几种实用的实现方式，无需取消工作流即可跳过生产部署，同时保持工作流及PR的成功状态：

1. 手动触发时通过输入参数控制生产部署 #

将工作流设置为支持手动触发，通过自定义输入参数决定是否执行生产部署阶段：

name: CI/CD 主分支流水线
on:
  push:
    branches: [main]
  workflow_dispatch:
    inputs:
      deploy_prod:
        description: '是否部署至生产环境'
        type: boolean
        required: true
        default: false

jobs:
  deploy-test:
    runs-on: ubuntu-latest
    steps:
      - name: 部署测试环境
        run: |
          # 此处替换为测试环境部署命令
          echo "测试环境部署完成"

  deploy-prod:
    needs: deploy-test
    runs-on: ubuntu-latest
    # 仅当手动触发且选择部署生产时执行
    if: github.event_name == 'workflow_dispatch' && github.event.inputs.deploy_prod == 'true'
    steps:
      - name: 部署生产环境
        run: |
          # 此处替换为生产环境部署命令
          echo "生产环境部署完成"

• 使用方式：触发工作流时选择「Run workflow」，将是否部署至生产环境设为false，生产部署阶段会被标记为Skipped，整个工作流状态保持成功，不会影响PR的状态。

2. 通过PR标签或提交关键词自动跳过 #

如果工作流由PR触发，可通过PR标签或提交信息中的关键词控制生产部署：

jobs:
  deploy-prod:
    needs: deploy-test
    runs-on: ubuntu-latest
    # 当PR包含skip-prod标签或提交信息含[skip-prod]时跳过
    if: >
      !contains(github.event.pull_request.labels.*.name, 'skip-prod') &&
      !contains(github.event.head_commit.message, '[skip-prod]')
    steps:
      - name: 部署生产环境
        run: echo "生产环境部署完成"

• 使用方式：仅需测试环境时，给PR添加skip-prod标签，或在提交信息中加入[skip-prod]，生产部署阶段会自动跳过，工作流保持成功。

3. 结合环境保护规则处理跳过逻辑 #

给生产环境配置审批规则，同时在工作流中处理审批拒绝的情况，确保阶段标记为成功：

1. 先在仓库「Settings > Environments」中，给生产环境添加「Required reviewers」；
2. 调整工作流文件：

jobs:
  deploy-prod:
    needs: deploy-test
    runs-on: ubuntu-latest
    environment: production
    steps:
      - name: 检查审批状态
        id: check_approval
        run: |
          # 通过GitHub API获取当前环境审批状态，判断是否需要跳过
          # 示例逻辑：若没有审批通过，则设置skip为true
          echo "skip=true" >> $GITHUB_OUTPUT
      - name: 执行生产部署
        if: steps.check_approval.outputs.skip != 'true'
        run: echo "生产环境部署完成"
      - name: 标记跳过为成功
        if: steps.check_approval.outputs.skip == 'true'
        run: echo "跳过生产部署，任务标记为成功"

• 使用方式：不需要部署生产时，拒绝审批请求，工作流会执行「标记跳过为成功」步骤，避免job失败。

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