Recommended way to stop a Gradle build

groovy build gradle
Kartoch picture Kartoch · Apr 25, 2012 · Viewed 71.8k times · Source

How can I stop a Gradle build after detecting a problem? I can use an assert, throw an exception, do a System.exit (bad idea), or use a dedicated function in Gradle (but I could not find one). What is the best way for Gradle (and why?).

Answer

tim_yates picture tim_yates · Apr 25, 2012

I usually throw the relevant exception from the org.gradle.api package, for example InvalidUserDataException for when someone has entered something invalid, or GradleScriptException for more general errors.

If you want to stop the current task or action, and move on to the next, you can also throw a StopActionException

Related questions

Gradle does not find tools.jar

I am using javadoc doclets with gradle, so I need to use the package tools.jar, which is in the lib folder from the jdk (1.6.0_26 in my case). The point is that gradle does not take it automatically, so I …

Read More
How can I import one Gradle script into another?

I have a complex gradle script that wraps up a load of functionality around building and deploying a number of netbeans projects to a number of environments. The script works very well, but in essence it is all configured through …

Read More
How to define and use a constant in Gradle build script (Android)?

I'm working on an Android application with Gradle as its build system. My objective is to use a value (a package name) as an applicationId: productFlavors { orange { applicationId "com.fruits.android.orange" // ... But also to expose it via BuildConfig so …

Read More