Gradle Build Step
A build step running gradle script
Example. Adds a simple Gradle step with custom tasks and a build file determined by Gradle. The Gradle Wrapper located in the checkout directory is used.
buildType {
// Other Build Type settings ...
steps {
// Other Build Steps ...
gradle {
name = "Build myproject"
tasks = ":myproject:clean :myproject:build"
}
Content copied to clipboard }
}
Example. Add a Gradle build step with a custom Gradle task and a build file in a custom working directory. Gradle incremental building feature is enabled. Additional Gradle command line parameters are specified with a reference to a configuration parameter. Gralde build step is set up not to use Gradle Wrapper, so Gradle will be taken from the agent's GRADLE_HOME environment variable. Additional run parameter for printing stacktrace is enabled. This step will be run inside a Docker container. IDEA-based code coverage is enabled.
buildType {
// Other Build Type settings ...
steps {
// Other Build Steps ...
gradle {
name = "Test my project in Docker"
tasks = "clean test"
buildFile = "build-test.gradle"
incremental = true
workingDir = "tests/"
gradleParams = "%myproject.version%"
useGradleWrapper = false
enableStacktrace = true
coverageEngine = idea {
includeClasses = """
org.group.example.*
org.group.common
""".trimIndent()
excludeClasses = "org.group.common.test.*"
}
dockerImage = "gradle:jdk11"
dockerImagePlatform = GradleBuildStep.ImagePlatform.Linux
}
Content copied to clipboard }
}
Example. Adds a Gradle build step with 'default' Gradle task and custom Gradle build file. Gradle Wrapper using is disabled, so Gradle will be taken with reference to an environment variable. JDK is set to the environment variable value with custom command line parameters. This build step will run even if some previous build steps failed.
buildType {
// Other Build Type settings ...
steps {
// Other Build Steps ...
gradle {
name = "Default run on JDK 11"
executionMode = BuildStep.ExecutionMode.RUN_ON_FAILURE
buildFile = "build-dev.gradle"
gradleHome = "%env.GRADLE_DEV_HOME%"
useGradleWrapper = false
jdkHome = "%env.JDK_11_0%"
jvmArgs = "-Xmx2048m"
}
Content copied to clipboard }
}
See also
Properties
The path to a custom Gradle build file. Leave this field empty if your build file is build.gradle located in the root directory. This property is deprecated for Gradle versions 9.0 and higher, use the additional -p <path-relative-to-checkout-directory>
command line parameter instead.
Optional collection of build step execution conditions
Specifies coverage engine to use
Specifies which Docker image to use for running this build step. I.e. the build step will be run inside specified docker image, using 'docker run' wrapper.
Specifies which Docker image platform will be used to run this build step.
If enabled, "docker pull image" will be run before docker run.
Additional docker run command arguments
Runs Gradle with the 'debug' (-d) log level. See also: Logging Sensitive Information.
Allows Gradle to print truncated stacktraces.
Build step execution mode
The path to a custom Gradle version. This version will be used instead of the default Gradle version referenced by the GRADLE_HOME environment variable.
Optional space-separated command-line parameters
The path (relative to the working directory) to a Gradle Wrapper script
Enable this option to allow TeamCity to detect Gradle modules affected by a modified build, and run the :buildDependents only for these affected modules.
Enable this setting if TeamCity should look for a Gradle Wrapper script in the project directory.
Custom working directory for the Gradle script
Functions
Deletes all configured build step conditions
Configures build step conditions
Copies parameters of this object to the specified target
Validates this object and reports found errors to the provided consumer