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

ScriptBuildStep

fun BuildSteps.script(init: ScriptBuildStep.() -> Unit): ScriptBuildStep

A build step running a script with the specified content

Example. Runs a script in the checkout directory.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        script {
            scriptContent = "echo 'hello'"
        }
Content copied to clipboard
    }
}

Example. Runs a multiline script in the specified build working directory with an argument referencing to the configuration parameter. Any of stderr output will be treated as errors.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        script {
            name = "Run tests"
            workingDir = "tests"
            scriptContent = """
                echo "Running tests for version %product.version%"
                ./run_tests.sh "%product.version%"
            """.trimIndent()
            formatStderrAsError = true
        }
Content copied to clipboard
    }
}

Example. Runs a multiline script in the specified build working directory in the specified Docker container with an argument referencing to the configuration parameter.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        script {
            name = "Run tests in Docker"

            workingDir = "tests"
            scriptContent = """
                echo "Running tests for version %product.version%"
                ./run_tests.sh "%product.version%"
            """.trimIndent()

            dockerImage = "nodejs:lts"
            dockerImagePlatform = ScriptBuildStep.ImagePlatform.Linux
            dockerRunParameters = "--rm --interactive=false"
        }
Content copied to clipboard
    }
}

Constructors

ScriptBuildStep

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

constructor()

Types

ImagePlatform

enum ImagePlatform : Enum<ScriptBuildStep.ImagePlatform>

Docker image platforms

Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

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: ScriptBuildStep.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

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

formatStderrAsError

var formatStderrAsError: Boolean?

Log stderr output as errors in the build log

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.

name

var name: String

Build step name

params

val params: List<Parameter>

scriptContent

var scriptContent: String?

Content of the script to run

type

var type: String

Build step type

workingDir

var workingDir: String?

Build working directory for script, specify it if it is different from the checkout directory.

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