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

ScriptBuildStep

open class ScriptBuildStep : BuildStep

A build step running a script with the specified content

See Also

script

Types

ImagePlatform

enum class ImagePlatform

Docker image platforms

Constructors

<init>

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

A build step running a script with the specified content

Properties

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

formatStderrAsError

var formatStderrAsError: Boolean?

Log stderr output as errors in the build log

scriptContent

var scriptContent: String?

Content of the script to run

workingDir

var workingDir: String?

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

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

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