如何配置pipeline仅在审批合并后启动或显示manual deploy选项
GitLab MR Pipeline 触发规则调整方案
两种预期效果完全可以通过平台原生配置实现,不需要额外二次开发,两种落地路径如下:
路径1:核心Pipeline完全等待MR审批通过后再启动
- 调整项目根目录下CI配置文件
.gitlab-ci.yml的触发规则,拆分两类任务的触发逻辑:- 把MR提交时需要自动运行的轻量检查(比如代码格式校验、单元测试),保留
merge_request_event的触发规则,这类任务会在MR提交时正常自动运行 - 把需要等待审批的全量构建、部署类核心任务,移除MR事件的自动触发规则,改为绑定目标合并分支(比如
main、生产发布分支)的触发规则,只有当MR通过审批、合并到目标分支后,这类核心pipeline才会自动启动
- 把MR提交时需要自动运行的轻量检查(比如代码格式校验、单元测试),保留
- 注意排查源分支的自动触发规则,避免因为源分支push动作提前触发核心pipeline。
路径2:在流水线页面展示可控的手动Deploy选项
这种方式调整成本更低,直接用CI原生的手动任务能力即可:
- 在
.gitlab-ci.yml对应流水线阶段下,给需要等待审批的部署、构建类任务添加when: manual属性,配置后这类任务不会跟随MR提交的pipeline自动运行,只会在流水线详情页展示可点击的启动按钮 - 配合项目自带的MR审批权限做联动:在项目审批设置中,指定只有通过MR审批的账号拥有该手动任务的操作权限,未审批通过的用户即使看到按钮也无法触发操作
- 最小可参考配置片段:
stages: - code_check - deploy # MR提交自动运行的代码检查,无需审批 lint_check: stage: code_check script: npm run lint rules: - if: $CI_PIPELINE_SOURCE == 'merge_request_event' # 需手动触发的部署任务,不会自动运行 manual_prod_deploy: stage: deploy script: npm run deploy:prod when: manual allow_failure: false
常见配置踩坑:如果配置手动任务后,发现MR阶段的pipeline一直阻塞等待手动操作,只需要将该手动任务的触发规则从MR事件中移除,改为仅在合并目标分支的pipeline中生效,就不会在MR流程页提前展示该选项。
内容的提问来源于stack exchange,提问作者Mani
相关产品推荐
相关产品推荐

