Get git branch name in Jenkins Pipeline Jenkinsfile

Question

I ve create a jenkins pipeline and it is pulling the pipeline script from scm  I set the branch specifier to  all   so it builds on any change to any branch    How do I access the branch name causing this build from the Jenkinsfile     Everything I have tried echos out null except   sh returnStdout  true  script   git rev-parse --abbrev-ref HEAD   trim     which is always master

User · Answer

A colleague told me to use scm branches 0  name and it worked  I wrapped it to a function in my Jenkinsfile   def getGitBranchName         return scm branches 0  name

User · Answer

Switching to a multibranch pipeline allowed me to access the branch name  A regular pipeline was not advised

User · Answer

For pipeline   pipeline     environment        BRANCH NAME      GIT BRANCH split      1

User · Answer

Just getting the name from scm branches is not enough if you ve used a build parameter as a branch specifier  e g    BRANCH   You need to expand that string into a real name   scm branches first   getExpandedName env getEnvironment      Note that getEnvironment   must be an explicit getter otherwise env will look up for an environment variable called environment   Don t forget that you need to approve those methods to make them accessible from the sandbox

User · Answer

This is for simple Pipeline type - not multibranch  Using Jenkins 2 150 1  environment       FULL PATH BRANCH      sh script  git name-rev --name-only HEAD   returnStdout  true        GIT BRANCH   FULL PATH BRANCH substring FULL PATH BRANCH lastIndexOf        1  FULL PATH BRANCH length         then use it env GIT BRANCH

User · Answer

FWIW the only thing that worked for me in PR builds was   CHANGE BRANCH   may not work on master  haven t seen that yet

User · Answer

For me this worked   using Jenkins 2 150  using simple Pipeline type - not multibranch  my branch specifier         echo  Pulling        env GIT BRANCH   Output   Pulling    origin myBranch   where myBranch is the name of the feature branch

User · Answer

Use multibranch pipeline job type  not the plain pipeline job type  The multibranch pipeline jobs do posess the environment variable env BRANCH NAME which describes the branch  In my script   stage  Build         node           echo  Pulling       env BRANCH NAME         checkout scm                   Yields    Pulling   master

User · Answer

If you have a jenkinsfile for your pipeline  check if you see at execution time your branch name in your environment variables   You can print them with   pipeline       agent any      environment           DISABLE AUTH    true          DB ENGINE       sqlite             stages           stage  Build                 steps                   sh  printenv                                    However  PR 91 shows that the branch name is only set in certain pipeline configurations    Branch Conditional  see this groovy script  parallel branches pipeline  as seen by the OP

[git] Get git branch name in Jenkins Pipeline/Jenkinsfile

Examples related to git

Examples related to jenkins

Examples related to branch

Examples related to jenkins-pipeline