Stop a Gradle Build with an Error

Internal

• Gradle Programming

Overview

To stop Gradle in the configuration phase with an error, usually caused by user input, or missing configuration, throw the relevant exception from org.gradle.api package:

• InvalidUserDataException
• GradleScriptException

Example

ext {

    String s = System.getenv("REQUIRED_ENVIRONMENT_VARIABLE");

    if (s == null) {

        throw new InvalidUserDataException("this Gradle build requires 'REQUIRED_ENVIRONMENT_VARIABLE' environment variable to be defined and meaningful, but the variable was not found in the environment!");
    }
}

Organizatorium

• StopActionException
• TaskExecutionException