如何在build.gradle中获取Jenkins GitSCM的CommitId、分支及仓库信息？

我来帮你搞定这个问题！你遇到的核心情况是：Jenkins用GitSCM checkout代码后，并不会自动把Git的commit ID、分支名、仓库URL这些信息注入到系统环境变量里，所以你在build.gradle里用System.getenv()拿这些值才会得到null。下面给你几个靠谱的解决方案，按推荐程度排序：

方案1：用Gradle插件直接读取本地Git仓库信息（最推荐） #

这个方法不依赖Jenkins的环境变量，不管是本地构建还是Jenkins构建都能正常工作，稳定性最高。我们可以用gradle-git-properties插件，它会自动从本地.git目录读取所有Git元数据：

1. 在你的build.gradle中添加插件依赖：

plugins {
    id 'com.gorylenko.gradle-git-properties' version '2.4.1'
}

2. 然后在build.gradle里直接获取需要的信息：

// 获取完整commit ID
def gitCommitId = gitProperties.get("git.commit.id")
// 获取短commit ID（7位）
def gitCommitIdShort = gitProperties.get("git.commit.id.abbrev")
// 获取当前分支名
def gitBranch = gitProperties.get("git.branch")
// 获取仓库远程URL
def gitRepoUrl = gitProperties.get("git.remote.origin.url")

// 如果你需要用System.getenv()的方式读取，也可以手动把这些值注入系统属性
System.setProperty("GIT_COMMIT", gitCommitId)
System.setProperty("GIT_BRANCH", gitBranch)
System.setProperty("GIT_URL", gitRepoUrl)

方案2：在Jenkins checkout后手动注入环境变量 #

如果必须依赖Jenkins的环境变量传递信息，可以在checkout步骤之后，用git命令手动获取这些值，然后设置为Jenkins环境变量，这样Gradle就能通过System.getenv()读取到了：

修改你的Jenkinsfile的Check Out阶段：

stage ('Check Out') {
    steps {
        echo 'Check-Out code from SCM'
        echo "Git Name : ${env.APP_NAME}"
        checkout([
            $class: 'GitSCM', 
            branches: [[name: "**/${BRANCH}"]], 
            doGenerateSubmoduleConfigurations: false, 
            extensions: [], 
            submoduleCfg: [], 
            userRemoteConfigs: [[ credentialsId: 'GITHUB_KEY' , url: "git@github.com:tools-org/${env.APP_NAME}"]]
        ])
        // 手动获取Git信息并设置为Jenkins环境变量
        script {
            // 获取完整commit ID
            def gitCommit = sh(script: 'git rev-parse HEAD', returnStdout: true).trim()
            // 获取当前分支名
            def gitBranch = sh(script: 'git rev-parse --abbrev-ref HEAD', returnStdout: true).trim()
            // 获取远程仓库URL
            def gitUrl = sh(script: 'git config --get remote.origin.url', returnStdout: true).trim()
            
            // 注入到Jenkins环境变量，后续步骤（包括Gradle）都能读取
            env.GIT_COMMIT = gitCommit
            env.GIT_BRANCH = gitBranch
            env.GIT_URL = gitUrl
        }
    }
}

之后在build.gradle里就能正常用System.getenv("GIT_COMMIT")、System.getenv("GIT_BRANCH")、System.getenv("GIT_URL")拿到值了。

方案3：通过GitSCM扩展自动注入环境变量 #

部分版本的Jenkins Git插件支持通过EnvVars扩展自动暴露Git相关的环境变量，你可以尝试修改checkout的extensions配置：

stage ('Check Out') {
    steps {
        echo 'Check-Out code from SCM'
        echo "Git Name : ${env.APP_NAME}"
        checkout([
            $class: 'GitSCM', 
            branches: [[name: "**/${BRANCH}"]], 
            doGenerateSubmoduleConfigurations: false, 
            extensions: [
                // 确保检出本地分支，避免 detached HEAD 状态影响分支名获取
                [$class: 'LocalBranch', localBranch: '**'],
                // 配置要暴露的Git环境变量
                [$class: 'EnvVars', envVars: ['GIT_COMMIT', 'GIT_BRANCH', 'GIT_URL']]
            ], 
            submoduleCfg: [], 
            userRemoteConfigs: [[ credentialsId: 'GITHUB_KEY' , url: "git@github.com:tools-org/${env.APP_NAME}"]]
        ])
    }
}

注意：这个方法依赖Jenkins Git插件的版本，如果你的插件版本较低可能不支持EnvVars扩展，所以方案1或方案2会更稳妥。

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