如何为GitHub Webhook Payload添加版本数据用于Jenkins构建

场景背景 #

Jenkins流水线由GitHub Pull Request（PR）触发，需要从Webhook Payload中提取版本号作为Docker镜像的构建标签。由于PR触发的Webhook不会包含Git标签信息，因此需要通过其他方式获取或传递版本数据。以下是几种可行的实现方式：

1. 从分支名称提取版本号 #

实现思路：约定分支命名规则（如feature/v1.2.3、hotfix/v2.0.1），直接从Payload的分支字段中解析版本号。

代码示例（修改Jenkins流水线的Get Version阶段）： #

stage('Get Version') {
    steps {
        script {
            def myobj = new JsonSlurper().parseText(payload)
            def branchName = myobj.pull_request.head.ref
            // 匹配分支名中的版本号格式（如v1.2.3）
            def versionMatcher = branchName =~ /v(\d+\.\d+\.\d+)/
            // 提取版本号，若匹配失败则用PR编号+短SHA生成默认标签
            version = versionMatcher.matches() ? versionMatcher[0][1] : "pr-${myobj.pull_request.number}-${myobj.pull_request.head.sha.take(7)}"
        }
    }
}

优缺点：

• 优点：无需额外操作，直接从Payload提取，实现简单
• 缺点：依赖严格的分支命名规范，团队需要统一执行

2. 从PR标题/描述提取版本号 #

实现思路：在PR标题或描述中加入版本标识（如feat: 新增支付功能 - v1.3.0），通过正则从Payload的pull_request.title或pull_request.body字段解析。

代码示例： #

stage('Get Version') {
    steps {
        script {
            def myobj = new JsonSlurper().parseText(payload)
            def prTitle = myobj.pull_request.title
            // 匹配标题中的版本号
            def versionMatcher = prTitle =~ /v(\d+\.\d+\.\d+)/
            version = versionMatcher.matches() ? versionMatcher[0][1] : "latest"
        }
    }
}

优缺点：

• 优点：灵活度高，无需修改分支命名
• 缺点：需要PR提交者手动添加版本标识，容易遗漏

3. 从PR关联的提交信息提取版本号 #

实现思路：利用Payload中PR头部提交的SHA值，调用GitHub API获取该提交的信息，从提交说明中解析版本号（如提交信息包含release: v1.4.0）。

代码示例（需确保Jenkins服务器能访问GitHub API，且配置了凭证）： #

stage('Get Version') {
    steps {
        script {
            def myobj = new JsonSlurper().parseText(payload)
            def repoFullName = myobj.pull_request.head.repo.full_name
            def commitSha = myobj.pull_request.head.sha
            // 调用GitHub API获取提交信息
            def commitMsg = sh(
                script: "curl -s -u \${GITHUB_USER}:\${GITHUB_TOKEN} https://api.github.com/repos/${repoFullName}/commits/${commitSha} | jq -r '.commit.message'",
                returnStdout: true
            ).trim()
            // 从提交信息中提取版本号
            def versionMatcher = commitMsg =~ /v(\d+\.\d+\.\d+)/
            version = versionMatcher.matches() ? versionMatcher[0][1] : "pr-${myobj.pull_request.number}-${commitSha.take(7)}"
        }
    }
}

注：GITHUB_USER和GITHUB_TOKEN需在Jenkins凭证中配置，并通过流水线环境变量引入。

优缺点：

• 优点：版本号与代码提交强关联，无需额外操作PR
• 缺点：需要调用外部API，依赖网络和凭证配置

4. 使用GitHub PR标签传递版本号 #

实现思路：给PR添加符合版本格式的标签（如v1.2.3），从Payload的pull_request.labels字段中提取对应标签作为版本号。

代码示例： #

stage('Get Version') {
    steps {
        script {
            def myobj = new JsonSlurper().parseText(payload)
            // 遍历PR标签，找到第一个符合版本格式的标签
            def versionLabel = myobj.pull_request.labels.find { label ->
                label.name =~ /v\d+\.\d+\.\d+/
            }
            version = versionLabel ? versionLabel.name : "latest"
        }
    }
}

优缺点：

• 优点：直观易管理，标签可在PR页面直接查看和修改
• 缺点：需要手动给PR添加标签，增加操作步骤

5. 自动生成版本标签（无需手动指定） #

实现思路：无需手动输入版本号，直接用PR编号、提交SHA或时间戳组合生成唯一标签，确保每个PR构建的镜像标签唯一可追踪。

代码示例（PR编号+短SHA）： #

stage('Get Version') {
    steps {
        script {
            def myobj = new JsonSlurper().parseText(payload)
            // 生成格式：pr-3-abc123（PR编号+7位提交SHA）
            version = "pr-${myobj.pull_request.number}-${myobj.pull_request.head.sha.take(7)}"
        }
    }
}

优缺点：

• 优点：无需人工干预，标签唯一且关联PR和提交
• 缺点：版本号可读性较弱，无法直观体现业务版本

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