TeamCity Kotlin DSL 2025.03/jetbrains.buildServer.configs.kotlin.buildSteps/GradleBuildStep

GradleBuildStep

fun BuildSteps.gradle(init: GradleBuildStep.() -> Unit): GradleBuildStep

A build step running gradle script

Example. Adds a simple Gradle step with custom tasks and build file determined by Gradle. Gralde 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 Gradles build step with custom Gradle task and build file localted in also custom working directory. Gradle incremental building feature is enabled. Additional Gradle command line parameters is 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 a 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 are 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
    }
}

Constructors

GradleBuildStep

constructor(init: GradleBuildStep.() -> Unit)

constructor()

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<GradleBuildStep.CoverageEngine>

ImagePlatform

enum ImagePlatform : Enum<GradleBuildStep.ImagePlatform>

Docker image platforms

Properties

buildFile

var buildFile: String?

Path to build file

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

coverageEngine

var coverageEngine: GradleBuildStep.CoverageEngine?

Specifies coverage engine to use

dockerImage

var dockerImage: String?

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.

dockerImagePlatform

var dockerImagePlatform: GradleBuildStep.ImagePlatform?

Specifies which Docker image platform will be used to run this build step.

dockerPull

var dockerPull: Boolean?

If enabled, "pull image" command will be run before docker run.

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

enableDebug

var enableDebug: Boolean?

Whether Gradle should be executed with the -d option

enableStacktrace

var enableStacktrace: Boolean?

Whether Gradle should be executed with the -s option

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

gradleHome

var gradleHome: String?

Path to the Gradle home directory (parent of 'bin' directory). Overrides agent GRADLE_HOME environment variable

gradleParams

var gradleParams: String?

Additional parameters will be added to the 'Gradle' command line

gradleWrapperPath

var gradleWrapperPath: String?

Optional path to the Gradle wrapper script, relative to the working directory

var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

incremental

var incremental: Boolean?

When set to true the :buildDependents task will be run on projects affected by changes

jdkHome

var jdkHome: String?

Custom JDK to use. The default is JAVA_HOME environment variable or the agent's own Java.

jvmArgs

var jvmArgs: String?

Space-separated list of additional arguments for JVM

name

var name: String

Build step name

params

val params: List<Parameter>

tasks

var tasks: String?

Space separated task names, when not set the 'default' task is used

type

var type: String

Build step type

useGradleWrapper

var useGradleWrapper: Boolean?

Whether TeamCity should look for Gradle Wrapper scripts in the checkout directory and run script using it

workingDir

var workingDir: String?

Custom working directory for gradle script

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter