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

SimpleBuildTool

fun BuildSteps.simpleBuildTool(init: SimpleBuildTool.() -> Unit): SimpleBuildTool

A Simple Build Tool (Scala) build step running SBT builds.

Example. Adds a Simple Build Tool (Scala) build step with default parameters and Java setup.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        simpleBuildTool {
            name = "My SBT step"
            commands = "compile test"
        }
Content copied to clipboard
    }
}

Example. Adds a Simple Build Tool (Scala) build step with custom working directory, custom installation mode, and Java parameters.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        simpleBuildTool {
            name = "My SBT step"
            workingDir = "project/"
            commands = "compile test"
            installationMode = custom {
                sbtHome = "path/to/sbt/home"
            }
            jdkHome = "%env.JDK_11_0%"
            jvmArgs = "-Xmx512m"
        }
Content copied to clipboard
    }
}

Constructors

SimpleBuildTool

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

SimpleBuildTool

fun SimpleBuildTool()

Types

InstallationMode

sealed class InstallationMode : CompoundParam<SimpleBuildTool.InstallationMode>

Functions

auto

fun auto(): SimpleBuildTool.InstallationMode.Auto

TeamCity bundled SBT launcher will be used.

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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.

custom

fun custom(init: SimpleBuildTool.InstallationMode.Custom.() -> Unit = {}): SimpleBuildTool.InstallationMode.Custom

The installed SBT will the launched from the SBT home (sbtHome).

doubleParameter

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

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

commands

var commands: <ERROR CLASS>

Commands to execute, e.g. 'clean compile test' or ';clean;set scalaVersion:="2.11.6";compile;test' for commands containing quotes.

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.

installationMode

var installationMode: <ERROR CLASS>

jdkHome

var jdkHome: <ERROR CLASS>

Specify the path to your custom JDK which will be used to run the build. The default is JAVA_HOME environment variable or the agent's own Java. The value could reference to some environment variable, e.g. "%env.JDK_18%".

jvmArgs

var jvmArgs: <ERROR CLASS>

Specify the desired Java Virtual Machine parameters, such as maximum heap size or parameters that enable remote debugging. These settings are passed to the JVM used to run your build.

name

var name: String

Build step name

params