TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/BuildStep

BuildStep

open class BuildStep : Parametrized, Validatable

Represents TeamCity Build Step. Use concrete build step classes such as MavenBuildStep instead of this class.

Example. Command line build step

See also script build step

steps {
    script {
        scriptContent = """echo "Hello world!""""
    }
}

Example. Maven build step

See also Maven build step

maven {
    goals = "clean package"
}

Inheritors

Constructors

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

Creates a build step and initializes it with the specified init block

constructor()

Types

enum ExecutionMode : Enum<BuildStep.ExecutionMode>

Specifies how build step should be executed in case of failures in other steps

Properties

var conditions: BuildStepConditions

Optional collection of build step execution conditions

var enabled: Boolean

Specifies whether the step is enabled, true by default

var executionMode: BuildStep.ExecutionMode

Build step execution mode

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.

var name: String

Build step name

val params: List<Parameter>

var type: String

Build step type

Functions

booleanParameter

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

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

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

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

Configures build step conditions

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

Copies parameters of this object to the specified target

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

fun doubleParameter(customName: String? = null): DelegateProvider<Double>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

fun findRawParam(paramName: String): Parameter?

fun hasParam(paramName: String): Boolean

fun intParameter(customName: String? = null): DelegateProvider<Int>

fun param(name: String, value: String)

Adds parameter with specified name and value

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): DelegateProvider<String>

open override fun toString(): String

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer