GitLab pipeline 如何配置为仅在merge request提交并获批后才触发
GitLab Pipeline 触发规则调整方案
原配置现存问题
你当前编写的.gitlab-ci.yaml存在多处会导致触发逻辑失效的语法硬伤,是当前pipeline触发不符合预期的核心原因之一:
- YAML语法不允许同一层级重复定义相同键:每个Job先后写了两次
only字段,YAML解析时后者会完全覆盖前者,原本想要限定的Test分支触发逻辑根本不会生效;StagingJob里重复定义了两次script字段,同样存在覆盖失效的问题 - 旧版
only/except触发规则和when: always搭配存在逻辑冲突,且这套语法已经被GitLab标记为长期废弃状态,后续版本升级很可能出现兼容性问题 - 脚本中编写的
git checkout、git pull属于冗余操作:CI运行环境已经通过你配置的GIT_STRATEGY: clone拉取了对应版本的代码,运行容器内没有配置远程仓库的认证凭证,执行这类git命令大概率会直接报权限错误
实现「仅MR提交且获得批准后才启动pipeline」的配置步骤
要实现指定触发逻辑,需要同时调整项目级合并规则和CI配置文件,仅修改CI文件无法识别MR的实时批准状态:
1. 项目侧基础配置调整
- 进入项目的合并请求设置页,开启「合并前必须通过强制审批」的规则,关闭普通分支推送时自动触发pipeline的默认行为
- 开启「MR状态变更同步触发关联流程」的权限,确保MR的批准状态可以正常传递到CI运行环境
2. 修正后的.gitlab-ci.yaml参考配置
使用GitLab新版rules语法替换废弃的only/except,绑定内置MR状态变量实现条件判断——只有同时满足「触发来源是合并请求事件」「对应MR已获得批准」两个条件时,才会启动pipeline,参考配置如下:
stages: - Test - Staging - Prod variables: GIT_STRATEGY: clone # 公共触发规则锚点,三个Job复用同一套判断逻辑 .common_trigger_rule: &common_trigger rules: # 匹配MR事件、且MR状态为已批准的场景,正常运行 - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_APPROVED == "true"' when: on_success # 其余所有场景(普通分支推送、MR未批准、tag触发等)均不运行 - when: never Test: stage: Test tags: - test script: - cd app_directory/Test allow_failure: false <<: *common_trigger Staging: stage: Staging tags: - staging script: - cd app_directory/Staging allow_failure: false <<: *common_trigger Prod: stage: Prod tags: - Prod script: - cd app_directory/Prod allow_failure: false <<: *common_trigger
补充说明
- 配置生效后,MR刚提交、代码有新推送但未获得批准时,pipeline完全不会启动;只有当MR收到有效批准、状态切换为已批准时,才会触发全流程pipeline
- 如果你需要给不同Stage设置差异化触发逻辑(比如Test阶段MR提交就自动运行,Staging、Prod阶段需要等MR批准才启动),可以单独给对应Job替换专属的
rules配置,不需要所有Job共用同一套判断条件 - 注意不要在Job中配置
when: always,否则无论匹配到什么规则,Job都会被强制启动,直接绕过条件判断 - 如果你的GitLab版本低于13.7,不支持读取
$CI_MERGE_REQUEST_APPROVED内置变量,可以采用手动触发的替代方案:MR提交时触发pipeline,但所有Job默认处于等待状态,等MR完成批准流程后,再手动点击启动对应Job即可
内容的提问来源于stack exchange,提问作者user1695083
相关产品推荐
相关产品推荐

