如何通过Jenkins检查GitHub PR标题是否含有效JIRA工单编号

方案一：Pipeline脚本直接校验（推荐，灵活可控） #

如果你的Jenkins项目是Multibranch Pipeline或GitHub Organization类型，Jenkins会自动注入PR相关环境变量，直接在Jenfile里添加校验逻辑即可：

• 核心思路：获取PR标题，用正则匹配JIRA编号格式，不匹配则终止构建
• 示例代码：

pipeline {
    agent any
    stages {
        stage('校验PR标题') {
            steps {
                script {
                    // 获取PR标题，非PR触发的构建为空（可按需调整逻辑）
                    def prTitle = env.CHANGE_TITLE ?: ''
                    // 自定义JIRA编号正则，示例匹配PROJ-123这类格式
                    def jiraRegex = ~/[A-Z]{2,}-\d+/
                    if (!prTitle.matches(jiraRegex) && prTitle != '') {
                        error "PR标题必须包含有效JIRA工单编号（格式示例：PROJ-123）"
                    }
                }
            }
        }
        // 后续构建、测试等阶段...
    }
}

• 注意事项：确保项目配置中开启PR触发自动发现，比如在GitHub Organization项目的「Repository Sources」里勾选「Discover pull requests from forks」或对应PR选项，保证CHANGE_TITLE等环境变量能正确注入。

方案二：Freestyle项目脚本校验 #

如果使用Freestyle项目，可通过执行shell/batch命令调用GitHub API获取PR标题并校验：

1. 配置带repo权限的GitHub个人访问令牌，在Jenkins中添加为全局凭据
2. 添加「Execute shell」步骤，示例脚本：

# 从Jenkins环境变量获取PR编号
PR_ID=${CHANGE_ID}
# 替换为你的GitHub仓库信息
REPO_OWNER="你的用户名/组织名"
REPO_NAME="仓库名"
# 从凭据读取GitHub令牌
GITHUB_TOKEN=$(cat $JENKINS_HOME/secrets/credentials/你的凭据ID/text)

# 调用API获取PR标题
PR_TITLE=$(curl -s -H "Authorization: token ${GITHUB_TOKEN}" "https://api.github.com/repos/${REPO_OWNER}/${REPO_NAME}/pulls/${PR_ID}" | jq -r '.title')

# 校验JIRA编号格式
JIRA_PATTERN="[A-Z]{2,}-\d+"
if ! [[ ${PR_TITLE} =~ ${JIRA_PATTERN} ]]; then
    echo "错误：PR标题未包含有效JIRA工单编号"
    exit 1
fi

• 依赖：服务器需安装curl和jq工具。

更优方案：结合GitHub分支保护规则 #

仅Jenkins校验不够彻底，可配合GitHub分支保护规则强制PR必须通过校验才能合并：

1. 在GitHub仓库的「Settings」→「Branches」中创建分支保护规则
2. 勾选「Require status checks to pass before merging」，将Jenkins的构建状态（比如continuous-integration/jenkins/pr-merge）添加到必填检查项
3. 可选勾选「Include administrators」，确保管理员也遵守规则

这样只要Jenkins校验失败（标题无JIRA编号），GitHub就会阻止PR合并，从流程上彻底管控。

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