如何在詹金斯共享库中获取分支名称

Question

I'm trying to write my first Jenkins shared library and I'm struggling with something basic - getting the branch name.

I could do:

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

However, that requires a checkout. Would it be possible to get the branch name (for both multibranch and freestyle) pipeline projects? I know I'll be using git, but I would like to avoid doing a checkout (until it is necessary).

Answer 1

The GIT_BRANCH environment variable should give you what you want. It won't work in pipeline until Jenkins 2.60 and upgraded pipeline model definition plugin.

Answer 2

If you are using a pipeline job, you can

• Capture object returned from scm checkout
• Reference environment variable

---

pipeline {
    // ...
    stages {
        stage('Setup') {
            steps {
                script {
                    // capture scm variables
                    def scmVars = checkout scm
                    String branch = scmVars.GIT_BRANCH

                    // or use the environment variable
                    branch = env.GIT_BRANCH
                }
            }
        }
        // ...
    }
}

Environment variable reference.

Answer 3

I ended up using this:

 env.CHANGE_BRANCH ?: env.GIT_BRANCH ?: scm.branches[0]?.name?.split('/')[1] ?: 'UNKNOWN'

However, this requires me to approve several things in In-Script Approvals page.