How can I get the current git branch in gradle?

Question

I'm writing a task to deploy my application to the server. However, I'd like for this task to run only if my current git branch is the master branch. How can I get the current git branch?

`gradle-git` approach:

I know there is a gradle-git plugin that has a method getWorkingBranch() under the task GitBranchList, but anytime I try to execute

task getBranchName(type: GitBranchList) { print getWorkingBranch().name }

I get a "Task has not executed yet" error. I looked at the source and it throws that error when there is no branch set. Does that mean this method doesn't do quite what I think it does? That I need to set the branch somewhere?

Song Bee · Accepted Answer · 2016-04-21 05:05:06Z

58

You also are able to get git branch name without the plug-in.

def gitBranch() { def branch = "" def proc = "git rev-parse --abbrev-ref HEAD".execute() proc.in.eachLine { line -> branch = line } proc.err.eachLine { line -> println line } proc.waitFor() branch }

Refer to: Gradle & GIT : How to map your branch to a deployment profile

answered Apr 21, 2016 at 5:05

Song Bee

7901 gold badge8 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Jørgen Sivesind Over a year ago

Maybe this is a given, but it should be noted that many CI engines checkout out the latest commit in a detached state, instead of master or a named branch. In that case, this solution will return HEAD, not the branch name.

Leponzo Over a year ago

See this for an alternative that won't break the configuration cache.

JustTheHighlights Jan 17 at 7:20

@JørgenSivesind do you have a solution for CI?

Hiery Nomus · Accepted Answer · 2013-02-25 08:21:53Z

No this doesn't mean that the branch is not set. It means that the task hasn't really executed yet. What you're trying to do is calling a method in the configuration closure, whereas you probably want to call it after task execution. Try to change your task to:

task getBranchName(type: GitBranchList) << { print getWorkingBranch().name }

With the << you're adding a doLast, which will be executed after the task has been executed.

UncleBob · Accepted Answer · 2021-08-11 13:59:41Z

Here's essentially @Song Bi's answer, but in kotlin DSL (inspired by this thread here):

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile import java.io.ByteArrayOutputStream /** * Utility function to retrieve the name of the current git branch. * Will not work if build tool detaches head after checkout, which some do! */ fun gitBranch(): String { return try { val byteOut = ByteArrayOutputStream() project.exec { commandLine = "git rev-parse --abbrev-ref HEAD".split(" ") standardOutput = byteOut } String(byteOut.toByteArray()).trim().also { if (it == "HEAD") logger.warn("Unable to determine current branch: Project is checked out with detached head!") } } catch (e: Exception) { logger.warn("Unable to determine current branch: ${e.message}") "Unknown Branch" } }

Collectives™ on Stack Overflow

How can I get the current git branch in gradle?

`gradle-git` approach:

3 Answers 3

3 Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

gradle-git approach:

3 Answers 3

3 Comments

Comments

Comments

Linked

Related

`gradle-git` approach: