Jenkins GitHub插件上报commit状态时repos数组为空问题

问题基本信息 #

• 故障场景：Jenkins流水线配置GitHub commit状态上报时，状态无法正常推送到GitHub
• 环境版本：Jenkins v2.346.2，GitHub Plugin v1.34.4
• 异常特征：构建日志中commit sha值识别正常，但repos数组为空，日志样例：

[Set GitHub commit status (universal)] PENDING on repos [] (sha:xxxxxx) with context:ci/jenkins/build-status
[Set GitHub commit status (universal)] SUCCESS on repos [] (sha:xxxxxx) with context:ci/jenkins/build-status

现有配置 #

Jenkinsfile流水线配置 #

void setBuildStatus(String message, String state) {
  step([
      $class: "GitHubCommitStatusSetter",
      reposSource: [$class: "ManuallyEnteredRepositorySource", url: "https://github.com/my_org/my_repo"],
      contextSource: [$class: "ManuallyEnteredCommitContextSource", context: "ci/jenkins/build-status"],
      errorHandlers: [[$class: "ChangingBuildStatusErrorHandler", result: "UNSTABLE"]],
      statusResultSource: [ $class: "ConditionalStatusResultSource", results: [[$class: "AnyBuildResult", message: message, state: state]] ]
  ]);
}

pipeline {
    agent any
    
    stages {
        stage('Checkout Code') {
            steps {
                checkout scm
                setBuildStatus("Build started", "PENDING");
            }
        }
        
        stage('Build') {
            steps {
                // 构建逻辑
            }
        }
    }

    post {
      success {
        setBuildStatus("Build succeeded", "SUCCESS");
      }
      failure {
        setBuildStatus("Build failed", "FAILURE");
      }
  }
}

全局配置 #

已在Jenkins系统配置中完成GitHub服务器配置，配置参考截图：

排查修复步骤 #

日志中repos为空的核心原因是GitHub插件无法将你配置的仓库地址，和全局配置中已授权的GitHub服务端做关联匹配，按以下优先级操作即可修复：

• 修正硬编码的仓库URL格式
  手动填写的ManuallyEnteredRepositorySource仓库URL对格式要求严格，不符合规范的地址会被插件直接过滤：

  正确格式：https://github.com/组织名/仓库名
  禁止带尾部斜杠、禁止带.git后缀，组织名、仓库名大小写必须和GitHub实际地址完全一致
  按规范修改URL后先重跑构建，观察日志中repos数组是否正常加载仓库地址。

• 校验全局GitHub服务器配置
  进入Jenkins系统配置页找到GitHub Servers配置块检查：
  • 公开GitHub服务API地址必须配置为https://api.github.com；私有化部署的GitHub Enterprise需填写对应实例的API根地址，不能填仓库前端访问地址
  • 绑定的凭据必须为GitHub个人访问令牌（PAT）类型，令牌需授予目标仓库的repo:status权限，配置完成后点击「测试连接」，确认返回认证成功且拥有目标仓库访问权限
  • 必须勾选Manage hooks选项
• 替换仓库源为SCM自动识别（最稳妥方案）
  硬编码URL的方式兼容性差，直接将reposSource改为从当前拉取代码的SCM配置中自动读取仓库信息，无需手动填写URL，可彻底规避格式匹配问题，修改后的setBuildStatus方法如下：

  void setBuildStatus(String message, String state) {
    step([
        $class: "GitHubCommitStatusSetter",
        reposSource: [$class: "ScmReposSource"],
        contextSource: [$class: "ManuallyEnteredCommitContextSource", context: "ci/jenkins/build-status"],
        errorHandlers: [[$class: "ChangingBuildStatusErrorHandler", result: "UNSTABLE"]],
        statusResultSource: [ $class: "ConditionalStatusResultSource", results: [[$class: "AnyBuildResult", message: message, state: state]] ]
    ]);
  }
  

  只要checkout scm步骤能正常拉取代码，该配置就能自动识别对应仓库，不会出现空repos的问题。
• 校验任务级SCM配置
  如果是单分支流水线任务，确认checkout步骤绑定的GitHub凭据和全局GitHub服务器配置使用的是同一个有权限的PAT；如果是多分支流水线任务，确认分支源中已正确添加目标GitHub仓库，扫描凭据拥有对应仓库的状态上报权限。

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