GitHub Actions通用run-name：覆盖PR与分支标签验证场景

完全可以通过GitHub Actions的表达式语法实现动态run-name，无需维护多个重复工作流。以下是具体实现方案，覆盖PR自动验证、手动触发分支/标签验证的场景，同时保证运行名称清晰易读。

核心思路 #

利用GitHub Actions的条件表达式（if-else逻辑），根据触发事件类型（PR/手动触发）和手动输入参数，动态生成对应的运行名称。

完整工作流示例 #

name: 基础验证工作流

on:
  # 监听Pull Request事件，自动触发验证
  pull_request:
    branches: [main, develop] # 按需指定需要验证的分支
  # 允许手动触发，支持选择分支或标签
  workflow_dispatch:
    inputs:
      target_type:
        description: 验证目标类型
        required: true
        type: choice
        options:
          - branch
          - tag
      branch_name:
        description: 要验证的分支名称
        required: false
        type: string
      tag_name:
        description: 要验证的标签名称
        required: false
        type: string

# 动态生成运行名称
run-name: >-
  ${{
    github.event_name == 'pull_request' && format('PR #{0}: {1}', github.event.number, github.event.pull_request.title) ||
    github.event.inputs.target_type == 'branch' && format('手动分支验证: {0}', github.event.inputs.branch_name) ||
    github.event.inputs.target_type == 'tag' && format('手动标签验证: {0}', github.event.inputs.tag_name)
  }}

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - name: 拉取代码
        uses: actions/checkout@v4
        with:
          # 手动触发分支时拉取指定分支，标签时拉取对应标签，PR时自动拉取合并后的代码
          ref: >-
            ${{
              github.event_name == 'pull_request' && github.event.pull_request.head.sha ||
              github.event.inputs.target_type == 'branch' && github.event.inputs.branch_name ||
              github.event.inputs.target_type == 'tag' && github.event.inputs.tag_name
            }}

      # 后续添加你的基础验证步骤（比如lint、测试、构建等）
      - name: 代码检查
        run: npm run lint
      - name: 执行测试
        run: npm test

关键细节说明 #

1. 触发条件：同时配置pull_request和workflow_dispatch，覆盖自动和手动触发场景
2. 手动输入参数：通过workflow_dispatch.inputs让用户选择验证类型（分支/标签）并输入对应名称
3. 动态run-name：
   • PR触发时：显示PR #编号: PR标题，直观展示对应PR信息
   • 手动分支触发时：显示手动分支验证: 分支名
   • 手动标签触发时：显示手动标签验证: 标签名
4. 代码拉取适配：通过ref参数动态指定拉取的代码版本，确保不同场景下都能获取正确的代码

其他命名优化建议 #

如果需要更详细的信息，可以在run-name中加入触发者、时间等字段，比如：

run-name: >-
  ${{
    github.event_name == 'pull_request' && format('PR #{0} ({1}) - {2}', github.event.number, github.event.pull_request.head.ref, github.event.pull_request.title) ||
    github.event.inputs.target_type == 'branch' && format('手动分支验证: {0} by @{1}', github.event.inputs.branch_name, github.triggering_actor) ||
    github.event.inputs.target_type == 'tag' && format('手动标签验证: {0} by @{1}', github.event.inputs.tag_name, github.triggering_actor)
  }}

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