TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/KotlinScriptFileBuildStep

KotlinScriptFileBuildStep

open class KotlinScriptFileBuildStep : BuildStep

fun BuildSteps.kotlinFile(init: KotlinScriptFileBuildStep.() -> Unit): KotlinScriptFileBuildStep

A build step running a Kotlin script with from a specified file

Example. Adds a Kotlin script build step with default Kotlin compiler and default JVM.

kotlinScript {
    name = "My Kotlin Script step"
    path = "script.kts"
}

Example. Adds a Kotlin script build step with bundled Kotlin compiler and custom JDK is set to the environment variable value with additional parameter. Additional agruments are passed to the Kotlin script with a reference to the configuration parameter value. Custom working directory is provided.

kotlinScript {
    name = "My Kotlin Script step"
    workingDir = "scripts/"
    path = "script.kts"

    compiler = "%teamcity.tool.kotlin.compiler.bundled%"
    arguments = "%myscript.params%"

    jdkHome = "%env.JDK_15_0%"
    jvmArgs = "-Xmx2048m"
}

Example. Adds a Kotlin script build step with custom Kotlin compiler and custom JDK with additional parameter. Custom working directory is provided.

kotlinScript {
    name = "My Kotlin Script step"
    workingDir = "scripts/"
    path = "script.kts"

    compiler = "path/to/kotlin/compiler"

    jdkHome = "path/to/jdk"
    jvmArgs = "-Xmx2048m"
}

Constructors

KotlinScriptFileBuildStep

fun KotlinScriptFileBuildStep(init: KotlinScriptFileBuildStep.() -> Unit)

KotlinScriptFileBuildStep

fun KotlinScriptFileBuildStep()

Functions

booleanParameter

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

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): CompoundDelegateProvider<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

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

enumParameter

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

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

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

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

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

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

arguments

var arguments: String?

Space-separated list of additional arguments for Kotlin script

compiler

var compiler: String?

Path to Kotlin compiler

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

var id: String? = null

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.

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