How to access git branch name from pipeline job?

Question

I have a Jenkins Pipeline job which is configured to checkout a git repo and a specific local branch.

How can i get the name of the local branch in my Jenkinsfile?

I tried to load the git jenkins plugin env properties but had no luck.

node { checkout scm echo "1 "+ env.GIT_LOCAL_BRANCH echo "2 "+ env.GIT_BRANCH }

Both values are "null"

Daniel Watrous · Accepted Answer · 2018-02-01 16:40:13Z

I found that I can capture the return value from checkout scm and use that to get the branch name (and other values)

 def scmVars node('api-sample-build') { stage('Clone source code') { scmVars = checkout scm // scmVars contains the following values // GIT_BRANCH=origin/mybranch // GIT_COMMIT=fc8279a107ebaf806f2e310fce15a7a54238eb71 // GIT_PREVIOUS_COMMIT=6f2e319a1fc82707ebaf800fce15a7a54238eb71 // GIT_PREVIOUS_SUCCESSFUL_COMMIT=310fce159a1fc82707ebaf806f2ea7a54238eb71 // GIT_URL=https://stash.someworkplace.com/scm/poc/api-sample.git } stage('test scope') { echo scmVars.GIT_BRANCH } }

By defining the variable outside the node it is available in stages after the checkout.

agilob · Accepted Answer · 2017-10-19 09:42:08Z

4

I'm now using the sh call to get the branch name. This requires at least version 2.4 of the Pipeline Nodes and Processes Plugin.

def branchName = sh(returnStdout: true, script: 'git rev-parse --abbrev-ref HEAD').trim() echo branchName

edited Oct 19, 2017 at 9:42

agilob

6,2633 gold badges37 silver badges52 bronze badges

answered Sep 20, 2016 at 8:57

Jotschi

3,6823 gold badges34 silver badges55 bronze badges

2 Comments

Javier PR Over a year ago

I've tried the same thing but I'm getting HEAD instead of the branch name... any ideas? I've tried other ways as git branch | grep * | cut ' ' -f but everything seems to return None or HEAD

KymikoLoco Over a year ago

@JavierPR You may be in a detached head state which won't work with this command. stackoverflow.com/questions/6059336 may help

Pom12 · Accepted Answer · 2016-09-20 12:29:08Z

1

You can use scm attributes to get the list of branches configured for your scm :

// List of all configured branches def allBranches = scm.branches // Only the first configured branch name def gitBranch = scm.branches[0].name

answered Sep 20, 2016 at 12:29

Pom12

7,9105 gold badges53 silver badges72 bronze badges

2 Comments

Ricardo Stuven Over a year ago

org.jenkinsci.plugins.scriptsecurity.sandbox.RejectedAccessException: Scripts not permitted to use method hudson.plugins.git.GitSCM getBranches

Oscar Bolaños Over a year ago

@RicardoStuven You need to authorize that method signature in the scripts console.

Collectives™ on Stack Overflow

How to access git branch name from pipeline job?

3 Answers 3

Comments

2 Comments

2 Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

2 Comments

2 Comments

Linked

Related