如何在Groovy Jenkinsfile中读取GitHub WebHook负载？

问题原因 #

直接在environment块里使用$.repository.name这类JSONPath写法无效，因为Jenkins的environment块不支持直接解析JSONPath，必须通过正确方式获取并解析WebHook传递的payload。

解决方案 #

方法1：利用GitHub插件自动注入的环境变量 #

若Jenkins已安装GitHub插件，WebHook触发流水线时，插件会自动将payload字段转换为大写字母+下划线格式的环境变量，嵌套结构用下划线分隔。比如repository.name对应的变量是GITHUB_REPOSITORY_NAME，直接调用即可：

pipeline {
  environment {
    REPO_NAME = "${env.GITHUB_REPOSITORY_NAME}"
  }
  stages {
    stage('Test') {
      steps {
        echo "仓库名称：${REPO_NAME}"
      }
    }
  }
}

方法2：手动解析WebHook Payload #

如果自动注入的变量不符合需求，可手动提取并解析payload：

pipeline {
  environment {
    REPO_NAME = script {
      // 找到GitHub WebHook触发的构建原因
      def githubCause = currentBuild.getBuildCauses().find { it.shortDescription.contains('GitHub hook') }
      if (githubCause) {
        // 解析payload为JSON对象，提取仓库名
        def payload = new groovy.json.JsonSlurper().parseText(githubCause.payload)
        return payload.repository.name
      } else {
        return 'unknown-repo'
      }
    }
  }
  stages {
    stage('Test') {
      steps {
        echo "仓库名称：${REPO_NAME}"
      }
    }
  }
}

方法3：脚本式流水线写法（可选） #

若使用脚本式流水线，写法更灵活：

node {
  def githubCause = currentBuild.getBuildCauses().find { it.shortDescription.contains('GitHub hook') }
  def repoName = 'unknown-repo'
  if (githubCause) {
    def payload = new groovy.json.JsonSlurper().parseText(githubCause.payload)
    repoName = payload.repository.name
  }
  echo "仓库名称：${repoName}"
}

注意事项 #

• 确保Jenkins能正常接收GitHub的WebHook请求，流水线触发条件需勾选"GitHub hook trigger for GITScm polling"
• JsonSlurper是Groovy自带类，无需额外安装插件
• 可在Jenkins构建页面的"构建原因"中查看原始payload，确认字段路径是否正确

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