如何根据GitHub Webhook触发事件类型执行Jenkins Pipeline不同阶段

我来帮你搞定这个问题！其实Jenkins在处理GitHub Webhook触发的任务时，完全可以获取到触发的事件类型，主要有两个可靠的途径，下面给你详细说明并附上示例：

一、利用Jenkins自动注入的环境变量 #

当你在Jenkins中配置了GitHub Integration插件（这是处理GitHub Webhook的核心插件），每次Webhook触发构建时，Jenkins会自动注入一系列和GitHub事件相关的环境变量，其中**GITHUB_EVENT_NAME**就是直接对应触发的事件类型，比如：

• pull_request：拉取请求相关事件（包括PR创建、更新等）
• push：代码推送事件（常用于部署触发）
• release：发布版本事件（如果你的部署是基于Release触发的）

你可以直接在Jenkinsfile中通过env.GITHUB_EVENT_NAME获取这个值，然后分支执行不同阶段。示例代码如下：

pipeline {
    agent any
    stages {
        stage('判断事件类型') {
            steps {
                script {
                    def eventType = env.GITHUB_EVENT_NAME
                    echo "当前触发事件类型: ${eventType}"
                }
            }
        }

        stage('PR构建与测试') {
            // 仅当事件是pull_request时执行此阶段
            when {
                expression { env.GITHUB_EVENT_NAME == 'pull_request' }
            }
            steps {
                echo "开始执行PR的代码检查、构建和自动化测试..."
                // 在这里添加你的PR专属步骤，比如单元测试、代码扫描等
            }
        }

        stage('生产环境部署') {
            // 当事件是push或release时执行部署
            when {
                expression { env.GITHUB_EVENT_NAME in ['push', 'release'] }
            }
            steps {
                echo "开始执行生产环境部署流程..."
                // 在这里添加你的部署步骤，比如镜像构建、K8s发布等
            }
        }
    }
}

二、读取GitHub事件的原始JSON文件 #

如果因为插件配置或版本问题，环境变量没有正常注入，你还可以直接读取Jenkins存储的GitHub事件原始数据文件。这个文件的路径是：
${env.JENKINS_HOME}/jobs/${env.JOB_NAME}/builds/${env.BUILD_NUMBER}/github-event.json

里面包含了Webhook发送的完整事件 payload，你可以用Jenkins的readJSON步骤解析它，获取更精细的事件信息（比如PR的action是opened还是synchronize）。示例代码：

pipeline {
    agent any
    stages {
        stage('解析GitHub事件') {
            steps {
                script {
                    def eventFilePath = "${env.JENKINS_HOME}/jobs/${env.JOB_NAME}/builds/${env.BUILD_NUMBER}/github-event.json"
                    def eventData = readJSON file: eventFilePath
                    
                    // 获取事件类型，PR事件会有action字段，push事件直接看event字段
                    def eventType = eventData.action ? "pull_request_${eventData.action}" : eventData.event
                    echo "当前触发事件详情: ${eventType}"

                    // 根据精细的事件类型执行逻辑
                    if (eventType.startsWith('pull_request')) {
                        echo "处理PR相关操作..."
                    } else if (eventType == 'push') {
                        echo "处理代码推送后的部署..."
                    }
                }
            }
        }
    }
}

注意事项 #

• 确保Jenkins已经安装并启用了GitHub Integration插件，这是上述方法生效的前提。
• 在GitHub的Webhook配置中，要勾选你需要触发的事件类型（比如Pull requests、Pushes、Releases等），并确保Payload URL正确指向Jenkins的Webhook端点。
• 对于Pull Request事件，如果你需要区分PR创建、更新、关闭等不同动作，可以通过eventData.action来进一步判断，让逻辑更精细。

这样就能完美实现根据不同的Webhook触发事件类型，运行对应的Pipeline阶段啦！

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