如何配置Gitlab仅在Jenkins流水线成功后合并PR？

一、Jenkins端配置 #

1. 安装必要插件 #

• 安装GitLab Plugin和Pipeline Plugin，优先选择最新稳定版本。

2. 配置Gitlab连接 #

• 进入Jenkins「系统管理」→「系统配置」，找到GitLab配置区域：
  • 填入你的Gitlab服务器地址（例如https://your-gitlab-domain.com）
  • 在Gitlab个人设置中创建个人访问令牌，需开启api、read_repository、write_repository权限，将令牌填入Jenkins的Gitlab连接配置，点击「测试连接」确认配置生效。

3. 配置PRBuilder流水线 #

• 新建流水线项目（命名为PRBuilder），核心配置如下：
  • 源码管理选择Git，填入仓库地址，配置可拉取代码的凭据。
  • 构建触发器勾选Build when a change is pushed to GitLab. GitLab CI Service URL: [Jenkins自动生成的回调地址]，并勾选触发事件为Merge Request events，指定目标分支为dev。
  • 流水线脚本示例（根据你的项目技术栈调整构建测试命令）：

    pipeline {
        agent any
        stages {
            stage('拉取PR代码') {
                steps {
                    git branch: "${env.gitlabMergeRequestSourceBranchName}", url: "${env.gitlabRepositoryUrl}"
                }
            }
            stage('构建与测试') {
                steps {
                    // 替换为你的项目构建测试命令，比如mvn clean test / npm run build:test等
                    sh './build-test-script.sh'
                }
            }
        }
        post {
            success {
                script {
                    gitlabCommitStatus name: 'PRBuilder', state: 'success'
                }
            }
            failure {
                script {
                    gitlabCommitStatus name: 'PRBuilder', state: 'failed'
                }
            }
        }
    }
    

  • 注：gitlabMergeRequest*系列环境变量由GitLab插件自动注入，用于获取PR的分支、仓库等信息。

二、Gitlab端配置 #

1. 设置仓库Webhook #

• 进入Gitlab仓库→「设置」→「Webhooks」：
  • 填入Jenkins项目中显示的GitLab回调地址
  • 勾选触发事件为Merge request events
  • 若Jenkins使用自签SSL证书，取消勾选Enable SSL verification，保存后点击「测试」确认返回200状态码。

2. 配置PR合并规则 #

• 进入仓库→「设置」→「合并请求」→「合并条件」：
  • 勾选Pipelines must succeed
  • 可选：勾选Require approval from code owners（根据团队需求开启）
  • 指定目标分支为dev，确保规则仅对合并到dev的PR生效。

3. 分支保护设置 #

• 进入仓库→「设置」→「分支保护」：
  • 找到dev分支，勾选Protect this branch
  • 勾选Prevent pushes to this branch，强制仅通过PR合并代码到dev
  • 勾选Require pipeline to pass before merging，确保只有流水线成功的PR才能合并。

三、流程验证 #

1. 新建分支并修改代码，向dev发起PR
2. 检查Jenkins是否自动触发PRBuilder流水线
3. 流水线失败时，Gitlab PR页面会显示失败状态，且合并按钮被禁用
4. 流水线成功时，PR页面显示成功状态，允许合并操作

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