Forma recomendada de detener una compilación de Gradle

Si quieres detener la compilación, lanza:

throw new GradleException('error occurred')

O lanzar las subclases para la excepción anterior. Algunas de las excepciones de subclases en realidad solo fallan en la tarea actual, pero continúan con la compilación.

Actualmente no hay un método dedicado, aunque ha habido discusiones para agregar uno.

La forma recomendada de detener una compilación de Gradle es lanzar una excepción. Como Groovy no ha marcado excepciones y Gradle, de forma predeterminada, no imprime el tipo de excepción, no es tan crítica la excepción que se lanza. En los scripts de compilación, GradleException se usa a menudo, pero una afirmación Groovy también parece razonable (dependiendo de las circunstancias y la audiencia). Lo importante es proporcione un mensaje claro. Agregar una causa (si está disponible) ayuda a depurar (--stacktrace).

Gradle proporciona tipos de excepción dedicadosStopExecutionException/StopActionException para detener la acción tarea/tarea actual pero continuar la compilación.

Otra opción si no tiene ningún deseo de poder capturar la excepción más adelante es llamar a la tarea ant fail. Es un poco más fácil de leer en mi opinión y se puede dar un mensaje agradable al usuario sin el uso de st stacktrace.

task (tarball, dependsOn: warAdmin) << {
    ant.fail('The sky is falling!!')
}

Te da un mensaje como:

* What went wrong:
Execution failed for task ':tarball'.
> The sky is falling!!

Probablemente tú can captura esto (tal vez lanza BuildException de ant? pero si eso es un objetivo, entonces no usaría ant.fallar. Sólo haría que fuera fácil ver qué excepción atrapar lanzando la excepción gradle estándar como sugiere tim_yates.

Lanzar una simple GradleException funciona para detener el script de compilación. Esto funciona muy bien para comprobación de la configuración del entorno requerida.

GradleException('your message, why the script is stopped.')

Ejemplo:

if(null == System.getenv()['GRADLE_USER_HOME']) {
    throw new GradleException('Required GRADLE_USER_HOME environment variable not set.')
}

Aquí hay un fragmento de código que intenta emular cómo la tarea Gradle javac arroja errores:

task myCommand(type:Exec) {

    ... normal task setup ....

    ignoreExitValue true
    standardOutput = new ByteArrayOutputStream()
    ext.output = { standardOutput.toString() }
    doLast {
        if (execResult.exitValue) {
            logger.error(output())
            throw new TaskExecutionException( it,
                new Exception( "Command '${commandLine.join(' ')}' failed; "
                              + "see task output for details." )
            )
        }
    }
}

Cuando el comando devuelve 0 no hay salida. Cualquier otro valor imprimirá la salida estándar y detendrá la compilación.

NOTA: Si su comando también escribe en errorOutput, puede que necesite incluirlo en el registro de errores.