如何在Jenkins任务中获取指定GitLab MR的全部评论内容

1. 环境变量支持说明 #

默认的GitLab Jenkins插件没有直接提供MR所有评论内容的内置环境变量，仅会在MR事件触发流水线时自动注入以下基础MR相关变量：

• gitlabMergeRequestId：你已获取的MR ID
• gitlabProjectId：MR所属的GitLab项目ID，调用接口必备参数
• gitlabUrl：GitLab实例的基础访问地址
• gitlabPrivateToken：可配置注入的GitLab访问凭证

如果你的流水线不是由GitLab MR事件自动触发，上述内置环境变量不会自动生成，需要你手动将MR ID、项目ID作为流水线参数传入。 #

2. 具体实现步骤 #

实现拉取评论的核心逻辑是调用GitLab官方开放接口：GET /projects/:id/merge_requests/:merge_request_iid/notes

2.1 前置准备 #

• 在GitLab中生成拥有目标项目read_api权限的私人访问令牌（PAT）
• 在Jenkins中将该PAT存储为「Secret text」类型的凭证，记录对应的凭证ID
• 确保Jenkins已安装GitLab Plugin、HTTP Request、Pipeline Utility Steps插件

2.2 Groovy代码实现示例 #

pipeline {
    agent any
    environment {
        // 注入GitLab PAT凭证，替换为你自己的凭证ID
        GITLAB_TOKEN = credentials('gitlab-pat-credential-id')
    }
    stages {
        stage('拉取MR所有评论') {
            steps {
                script {
                    // 从内置环境变量获取基础参数，手动触发的流水线可替换为自定义参数
                    def gitlabUrl = env.gitlabUrl
                    def projectId = env.gitlabProjectId
                    def mrId = env.gitlabMergeRequestId
                    
                    // 拼接GitLab API请求地址，per_page可根据评论数量调整最大值为100
                    def apiUrl = "${gitlabUrl}/api/v4/projects/${projectId}/merge_requests/${mrId}/notes?per_page=100"
                    
                    // 发送GET请求拉取评论数据
                    def response = httpRequest(
                        url: apiUrl,
                        customHeaders: [
                            [name: 'PRIVATE-TOKEN', value: "${GITLAB_TOKEN}"]
                        ],
                        failOnError: true,
                        consoleLogResponseBody: false // 不需要打印评论内容可关闭
                    )
                    
                    // 解析返回的JSON为Groovy对象
                    def allComments = readJSON text: response.content
                    
                    // 遍历处理评论，示例仅输出非系统生成的用户评论
                    allComments.each { comment ->
                        if (!comment.system) {
                            println "评论作者：${comment.author.name}"
                            println "评论内容：${comment.body}"
                            println "评论时间：${comment.created_at}"
                            println "-------------------------"
                        }
                    }
                    
                    // 可将评论内容存入环境变量供后续阶段使用
                    env.MR_ALL_COMMENTS = response.content
                }
            }
        }
    }
}

注意：如果评论数量超过100条，需要处理分页逻辑，通过响应头的X-Next-Page参数拉取下一页数据，直到所有数据拉取完成。

额外说明 #

• 若未安装HTTP Request插件，也可以用Groovy原生的HttpURLConnection发送请求，缺点是需要自行处理SSL校验、异常捕获等场景，更推荐使用插件实现
• 禁止将GitLab PAT硬编码在流水线代码中，必须通过Jenkins凭证管理注入，避免凭证泄露
• 若需要过滤系统自动生成的操作日志类评论，新增comment.system == false判断即可

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