能否通过Jenkins实现GitHub仓库变更时自动创建PR

该自动化流程完全具备可实现性，无需自研复杂组件，依托GitHub原生Webhook能力、Jenkins官方插件与GitHub开放API即可稳定落地，是目前工业界非常成熟的自动化提交流程方案。

整个流程拆分为三层逻辑，各环节无技术卡点：

• 触发层：通过GitHub Webhook监听指定仓库的代码变更事件（可精准配置监听的分支、文件路径、事件类型），事件触发后自动向Jenkins发起请求唤起对应构建任务
• 执行层：Jenkins任务拉取目标分支最新代码，执行预设的代码变更操作（如版本号升级、配置批量修改、自动化代码生成、依赖更新等），完成本地校验后将变更提交到独立的新功能分支并推送到远程仓库
• 交付层：Jenkins携带权限凭证调用GitHub接口，基于新推送的功能分支向目标分支发起Pull Request，可按需自动填充PR标题、描述、指定评审人、打标签，和手动创建PR的体验完全一致

前置准备 #

• 登录Jenkins后台，在插件管理中安装3个必备插件：GitHub Integration Plugin、Git Plugin、Pipeline，安装完成后重启Jenkins生效
• 在GitHub侧生成Personal Access Token（PAT），权限勾选repo全量仓库权限、pull_requests读写权限，将生成的PAT存入Jenkins凭证管理，凭证类型选择「Secret text」，记录好自定义的凭证ID后续调用
• 进入目标GitHub仓库的Settings -> Webhooks页面，新增Webhook：Payload URL填写http://<你的Jenkins服务地址>/github-webhook/，触发事件选择你需要监听的代码变更场景（一般选Push事件即可，可额外配置只监听特定分支的push），保存后发送测试请求，确认返回200状态码即配置生效

Jenkins流水线配置 #

• 新建Pipeline类型的Jenkins任务，在任务的「构建触发器」配置栏勾选GitHub hook trigger for GITScm polling，开启Webhook触发能力
• 在Pipeline脚本编辑区填入声明式流水线逻辑，可根据自身业务需求修改变更逻辑，参考脚本如下：

pipeline {
    agent any
    environment {
        // 替换为你之前存到Jenkins的GitHub PAT凭证ID
        GITHUB_TOKEN = credentials('your-github-pat-credential-id')
        // 替换为你的仓库路径 格式为 用户名/仓库名
        REPO_PATH = 'your-github-username/your-repo-name'
        REPO_URL = "https://github.com/${REPO_PATH}.git"
        // 替换为PR要合入的目标分支
        TARGET_BRANCH = 'main'
        // 自动生成唯一的新分支名，避免分支冲突
        NEW_BRANCH = "auto-pr/build-${BUILD_NUMBER}-${new Date().format('yyyyMMddHHmm')}"
    }
    stages {
        stage('拉取目标分支最新代码') {
            steps {
                git branch: TARGET_BRANCH, url: REPO_URL, credentialsId: 'your-github-pat-credential-id'
            }
        }
        stage('执行自动化代码变更') {
            steps {
                sh '''
                    # 以下替换为你实际需要执行的代码变更逻辑，示例为更新版本号文件
                    echo "v1.0.${BUILD_NUMBER}" > VERSION
                    # 配置git提交身份
                    git config user.name "jenkins-auto-bot"
                    git config user.email "jenkins-bot@your-company.com"
                '''
            }
        }
        stage('校验变更有效性') {
            steps {
                sh '''
                    # 检测是否存在实际文件变更，无变更则直接终止流程避免空PR
                    if [ -z "$(git status --porcelain)" ]; then
                        echo "无有效代码变更，终止流程"
                        exit 0
                    fi
                    # 可在这里额外加单元测试、代码规范校验逻辑，校验失败直接中断
                '''
            }
        }
        stage('推送分支并自动创建PR') {
            steps {
                sh '''
                    # 创建新分支、提交变更、推送到远程仓库
                    git checkout -b ${NEW_BRANCH}
                    git add .
                    git commit -m "auto: 自动化变更提交 构建号#${BUILD_NUMBER}"
                    git push https://${GITHUB_TOKEN}@github.com/${REPO_PATH}.git ${NEW_BRANCH}
                    
                    # 调用GitHub接口创建PR
                    curl -f -X POST \
                      -H "Authorization: token ${GITHUB_TOKEN}" \
                      -H "Accept: application/vnd.github.v3+json" \
                      https://api.github.com/repos/${REPO_PATH}/pulls \
                      -d '{
                        "title": "自动化PR：'${NEW_BRANCH}'",
                        "head": "'${NEW_BRANCH}'",
                        "base": "'${TARGET_BRANCH}'",
                        "body": "该PR由Jenkins自动触发创建，关联构建号：#'${BUILD_NUMBER}'，变更内容为自动化脚本执行的版本更新，请相关同学评审合入。",
                        "maintainer_can_modify": true
                      }'
                '''
            }
        }
    }
}

可选优化项 #

• 可在创建PR的接口请求中追加参数，实现自动指定评审人、打标签、关联里程碑、设置是否允许维护者修改分支等能力，完全覆盖手动创建PR的所有配置项
• 可在流水线最后增加通知环节，PR创建成功后通过企业微信、邮件等渠道通知对应评审人，避免PR遗漏
• 可增加分支清理逻辑，定期清理已经合入或者关闭的PR对应的自动化分支，避免仓库冗余分支过多

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