Jenkins Workflow Checkout Accessing BRANCH_NAME and GIT_COMMIT

Question

I cannot seem to extract $GIT_COMMIT and $BRANCH_NAME from a Jenkins Workflow Checkout step.

I would like to be able to send this information through to my Gradle sc

Answer 1

I have two Jenkins instances.

In both instances, GIT_COMMIT and BRANCH_NAME environment variables are not defined.

When I try to get them from the return value of checkout() call, each instance behaves differently.

Jenkins Instance 1

Jenkins version: 2.46.1

"Pipeline: SCM Step" plugin version: 2.5

Trying to access the environment variable as explained in the checkout documentation fails.

def scmVars = checkout([$class: 'GitSCM', branches: [[name: '*/master']], 
    userRemoteConfigs: [[credentialsId: '2b74a351-67d5-4d00-abd3-
    49842a984201', url: 'ssh://git@corporate.com:repo.git']]])
def commitHash = scmVars.GIT_COMMIT

scmVars returns NULL, and accessing scmVars.GIT_BRANCH fails with exception java.lang.NullPointerException: Cannot get property 'GIT_BRANCH' on null object.

So I had to do the following in order to get the branch:

sh 'git name-rev --name-only HEAD > GIT_BRANCH'
sh 'cat GIT_BRANCH'
git_branch = readFile('GIT_BRANCH').trim()
env.GIT_BRANCH = git_branch

Jenkins Instance 2

Jenkins version: 2.60.2

"Pipeline: SCM Step" plugin version: 2.6

In this instance, I could do the following with success:

def scmVars = checkout([$class: 'GitSCM', branches: [[name: '*/master']], 
    userRemoteConfigs: [[credentialsId: '2b74a351-67d5-4d00-abd3-
    49842a984201', url: 'ssh://git@corporate.com:repo.git']]])
env.GIT_COMMIT = scmVars.GIT_COMMIT
env.GIT_BRANCH = scmVars.GIT_BRANCH

So please check which approach works for your Jenkins instance and use it.