Stop a Gradle Build with an Error: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 18: Line 18:
     if (s == null) {
     if (s == null) {


         throw new InvalidUserDataException("this Gradle build needs 'REQUIRED_ENVIRONMENT_VARIABLE' environment variable to be defined and meaningful, but the variable was not found in the environment!");
         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!");
     }
     }
}
}

Revision as of 21:46, 14 March 2019

Internal

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:

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