jetbrains.buildServer.configs.kotlin.v2017_2.buildSteps / GradleBuildStep

GradleBuildStep

open class GradleBuildStep : BuildStep

A build step running gradle script

See Also

gradle

Types

CoverageEngine

sealed class CoverageEngine : CompoundParam<CoverageEngine>

ImagePlatform

enum class ImagePlatform

Docker image platforms

Constructors

<init>

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

A build step running gradle script

Properties

buildFile

var buildFile: String?

Path to build file

coverageEngine

var coverageEngine: 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: ImagePlatform?

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

dockerPull

var dockerPull: Boolean?

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

dockerRunParameters

var dockerRunParameters: String?

Additional docker run command arguments

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

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

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

tasks

var tasks: String?

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

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

Inherited Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executionMode

var executionMode: ExecutionMode

Build step execution mode

id

var id: String?

Id of the step, if not specified will be generated

name

var name: String

Build step name

type

var type: String

Build step type

Functions

idea

fun idea(init: Idea.() -> Unit = {}): Idea

jacoco

fun jacoco(init: Jacoco.() -> Unit = {}): Jacoco

validate

open fun validate(consumer: ErrorConsumer): Unit

Validates this object and reports found errors to the provided consumer

Inherited Functions

clearConditions

fun clearConditions(): Unit

Deletes all configured build step conditions

conditions

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

Configures build step conditions

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.

toString

open fun toString(): String