GitHub工作流运行列表如何展示附加信息及修改特定运行名称
需求可行性说明
GitHub工作流运行列表原生不支持自定义默认展示字段,无法直接在列表页默认加载展示分支名称、工作流输出、步骤注解这类附加信息:
- 列表页固定展示工作流名、运行状态、关联提交信息、触发人、运行时长几个预设字段,没有开放自定义列配置入口
- 分支名称、步骤注解、运行输出这类信息,目前仅支持点进单个工作流运行的详情页查看
- 没有官方支持的配置项可以把上述附加信息直接嵌入列表默认视图
手动触发工作流自定义运行名称的方法
针对带输入参数的手动触发(workflow_dispatch)工作流,可以通过工作流顶层的run-name字段,修改列表默认显示的「Run Nuke Target」名称,还可以间接把分支信息拼到展示名里,补上列表不显示分支的缺口。
配置方式如下:
- 打开仓库中
.github/workflows/路径下对应的Nuke工作流配置文件 - 在和
on、jobs同级的顶层位置添加run-name字段,支持通过GitHub Actions表达式读取手动输入的参数、内置上下文信息拼接展示名称
参考配置示例:
# 原有工作流名称 name: Nuke Build # 自定义运行列表展示名称 run-name: Run Nuke Target - ${{ inputs.target }} | 分支:${{ github.ref_name }} | 触发人:${{ github.actor }} on: workflow_dispatch: inputs: target: description: 选择要执行的Nuke Target required: true type: choice options: - Compile - Test - Publish # 原有任务配置保持不变 jobs: nuke: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 # 后续原有Nuke执行步骤
配置生效后,手动触发工作流时,列表里的运行条目就会按照你定义的规则显示名称,比如选择Test目标、分支为release-v1、触发人为webness时,显示名称为Run Nuke Target - Test | 分支:release-v1 | 触发人:webness。
补充说明:
run-name是工作流触发时就渲染生成的,默认无法直接读取job运行过程中产生的输出、注解内容,如果需要展示运行时生成的信息,需要额外申请repo权限的token,在工作流步骤中调用GitHub API更新运行名称,实现成本较高- 步骤注解、详细运行日志没有办法展示在运行列表页,必须进入详情页查看,属于GitHub产品本身的功能限制
内容的提问来源于stack exchange,提问作者webness
相关产品推荐
相关产品推荐

