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'"
}
}
}

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
}
}
}

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"
}
}
}

See also

Constructors

Link copied to clipboard
constructor(init: ScriptBuildStep.() -> Unit)
constructor()

Types

Link copied to clipboard

Docker image platforms

Properties

Link copied to clipboard

Optional collection of build step execution conditions

Link copied to clipboard
var dockerImage: <Error class: unknown class>

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.

Link copied to clipboard
var dockerImagePlatform: <Error class: unknown class>

Specifies which Docker image platform will be used to run this build step.

Link copied to clipboard
var dockerPull: <Error class: unknown class>

If enabled, "pull image" command will be run before docker run.

Link copied to clipboard
var dockerRunParameters: <Error class: unknown class>

Additional docker run command arguments

Link copied to clipboard

Specifies whether the step is enabled, true by default

Link copied to clipboard
Link copied to clipboard
var formatStderrAsError: <Error class: unknown class>

Log stderr output as errors in the build log

Link copied to clipboard
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.

Link copied to clipboard

Build step name

Link copied to clipboard
Link copied to clipboard
var scriptContent: <Error class: unknown class>

Content of the script to run

Link copied to clipboard

Build step type

Link copied to clipboard
var workingDir: <Error class: unknown class>

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

Functions

Link copied to clipboard
fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard

Deletes all configured build step conditions

Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer