Execute shell script in Gradle

Question

I have a gradle build setup at the beginning of which I want to execute a shellscript in a subdirectory that prepares my environment.

task build << {
}
task preBuild << {
    println 'do prebuild stuff:'
}
task myPrebuildTask(type: Exec) {
    workingDir "$projectDir/mySubDir"
    commandLine './myScript.sh'
}

build.dependsOn preBuild
preBuild.dependsOn myPrebuildTask

However, when I execute the task either by calling gradle myPrebuildTask or by simply building the project, the following error occurs:

> A problem occurred starting process 'command './myScript.sh''

Unfortunately, thats all I get.
I have also tried the following - same error.

commandLine 'sh mySubDir/myScript.sh'

I use Gradle 1.10 (needed by Android) on Windows, inside a Cygwin shell. Any ideas?

Matthias Braun · Accepted Answer · 2017-05-22 11:02:33Z

47

A more generic way of writing the exec task, but portable for Windows/Linux, if you are invoking a command file on the PATH:

task myPrebuildTask(type: Exec) {
    workingDir "$projectDir/mySubDir"
    if (System.getProperty('os.name').toLowerCase(Locale.ROOT).contains('windows')) {
        commandLine 'cmd', '/c', 'mycommand'
    } else {
        commandLine 'sh', '-c', 'mycommand'
    }
}

This doesn't directly address the use case for the OP (since there is script file in the working directory), but the title of the question is more generic (and drew me here), so it could help someone maybe.

edited May 22, 2017 at 11:02

Matthias Braun

34.8k27 gold badges158 silver badges177 bronze badges

answered Jun 17, 2016 at 1:39

Patrice M.

4,3392 gold badges29 silver badges39 bronze badges

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

Comments

Rene Groeschke · Accepted Answer · 2014-08-29 07:17:03Z

46

use

commandLine 'sh', './myScript.sh'

your script itself is not a program itself, that's why you have to declare 'sh' as the program and the path to your script as an argument.

answered Aug 29, 2014 at 7:17

Rene Groeschke

28.8k10 gold badges72 silver badges78 bronze badges

2 Comments

Paul Latzelsperger Over a year ago

different commands for executing under linux and windows (Cygwin) are needed. I ended up supplying the scriptname as parameter: commandLine 'sh','myScript.sh'

Oliver Metz Over a year ago

Remember to put the task into the project gradle file and not the module gradle file.

panser · Accepted Answer · 2017-04-26 00:22:30Z

21

unfortunately options with commandLine not worked for me in any way and my friend find other way with executable

executable "./myScript.sh"

and full task would be

task startScript() {
  doLast {
     exec {
          executable "./myScript.sh"
      }
  }
}

answered Apr 26, 2017 at 0:22

panser

2,14923 silver badges17 bronze badges

Comments

pigswig · Accepted Answer · 2018-07-26 18:45:27Z

9

This works for me in my Android project

preBuild.doFirst {
    println("Executing myScript")
    def proc = "mySubDir/myScript.sh".execute()
    proc.waitForProcessOutput(System.out, System.err)
}

See here for explanation: How to make System command calls in Java/Groovy?

answered Jul 26, 2018 at 18:45

pigswig

3513 silver badges8 bronze badges

Comments

Mahozad · Accepted Answer · 2023-09-12 16:04:02Z

This is a solution for Kotlin DSL (build.gradle.kts) derived from Charlie Lee's answer:

task<Exec>("MyTask") {
    doLast {
        commandLine("git")
            .args("rev-parse", "--verify", "--short", "HEAD")
            .workingDir(rootProject.projectDir)
    }
}

Another approach using the Java standard ProcessBuilder API:

tasks.create("MyTask") {
    val command = "git rev-parse --verify --short HEAD"
    doLast {
        val process = ProcessBuilder()
            .command(command.split(" "))
            .directory(rootProject.projectDir)
            .redirectOutput(Redirect.INHERIT)
            .redirectError(Redirect.INHERIT)
            .start()
        process.waitFor(60, TimeUnit.SECONDS)
        val result = process.inputStream.bufferedReader().readText()
        println(result)
    }
}

For more information see:

Sattar · Accepted Answer · 2020-01-17 13:29:41Z

2

for kotlin gradle you can use

 Runtime.getRuntime().exec("./my_script.sh")

answered Jan 17, 2020 at 13:29

Sattar

2,6522 gold badges35 silver badges52 bronze badges

Comments

Ayush Goyal · Accepted Answer · 2015-08-12 12:50:46Z

-9

I copied my shell scipt to /usr/local/bin with +x permission and used it as just another command:

commandLine 'my_script.sh'

answered Aug 12, 2015 at 12:50

Ayush Goyal

2,0898 gold badges33 silver badges47 bronze badges

5 Comments

Edgard Leal Over a year ago

This option works to, but i dont recomend put many files in /usr/local/bin

Gray Over a year ago

You sure you don't want to delete this answer?

Ayush Goyal Over a year ago

If I delete, one wouldn't know how not to do it. Plus, it did work for me.

JoeyG Over a year ago

While the suggested action "works" it doesn't allow for the project to be portable and will require manual steps from anyone who needs to run the gradle build for the project.

Den Drobiazko Over a year ago

@JoeyG I guess this can stay here. It is downvoted enough to give anyone seeking answer a hint that this recipe should be taken with caution :)

Collectives™ on Stack Overflow

Execute shell script in Gradle

7 Answers 7

Comments

2 Comments

Comments

Comments

Comments

Comments

5 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

7 Answers 7

Comments

2 Comments

Comments

Comments

Comments

Comments

5 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related