cli/foundry.cli.buildkite/ScriptStep

ScriptStep

@Serializable

data class ScriptStep(val agents: Agents? = null, val allowDependencyFailure: Boolean? = null, val artifactPaths: SimpleStringValue? = null, val branches: SimpleStringValue? = null, val cancelOnBuildFailing: Boolean? = null, val command: SimpleStringValue? = null, val commands: SimpleStringValue? = null, val concurrency: Long? = null, val concurrencyGroup: String? = null, val concurrencyMethod: ConcurrencyMethod? = null, val dependsOn: DependsOn? = null, val env: JsonObject? = null, val id: String? = null, val identifier: String? = null, val commandStepIf: String? = null, val key: String? = null, val label: String? = null, val matrix: MatrixUnion? = null, val name: String? = null, val notify: List<Notification>? = null, val parallelism: Long? = null, val plugins: Plugins? = null, val priority: Long? = null, val retry: Retry? = null, val signature: Signature? = null, val skip: Skip? = null, val softFail: SoftFail? = null, val timeoutInMinutes: Long? = null, val type: ScriptType? = null) : Keyable(source)

Constructors

ScriptStep

constructor(agents: Agents? = null, allowDependencyFailure: Boolean? = null, artifactPaths: SimpleStringValue? = null, branches: SimpleStringValue? = null, cancelOnBuildFailing: Boolean? = null, command: SimpleStringValue? = null, commands: SimpleStringValue? = null, concurrency: Long? = null, concurrencyGroup: String? = null, concurrencyMethod: ConcurrencyMethod? = null, dependsOn: DependsOn? = null, env: JsonObject? = null, id: String? = null, identifier: String? = null, commandStepIf: String? = null, key: String? = null, label: String? = null, matrix: MatrixUnion? = null, name: String? = null, notify: List<Notification>? = null, parallelism: Long? = null, plugins: Plugins? = null, priority: Long? = null, retry: Retry? = null, signature: Signature? = null, skip: Skip? = null, softFail: SoftFail? = null, timeoutInMinutes: Long? = null, type: ScriptType? = null)

Properties

agents

val agents: Agents? = null

allowDependencyFailure

@SerialName(value = "allow_dependency_failure")

val allowDependencyFailure: Boolean? = null

artifactPaths

@SerialName(value = "artifact_paths")

val artifactPaths: SimpleStringValue? = null

The glob path/s of artifacts to upload once this step has finished running

branches

val branches: SimpleStringValue? = null

cancelOnBuildFailing

@SerialName(value = "cancel_on_build_failing")

val cancelOnBuildFailing: Boolean? = null

command

val command: SimpleStringValue? = null

The commands to run on the agent

commands

val commands: SimpleStringValue? = null

The commands to run on the agent

commandStepIf

@SerialName(value = "if")

val commandStepIf: String? = null

concurrency

val concurrency: Long? = null

The maximum number of jobs created from this step that are allowed to run at the same time. If you use this attribute, you must also define concurrency_group.

concurrencyGroup

@SerialName(value = "concurrency_group")

val concurrencyGroup: String? = null

A unique name for the concurrency group that you are creating with the concurrency attribute

concurrencyMethod

@SerialName(value = "concurrency_method")

val concurrencyMethod: ConcurrencyMethod? = null

Control command order, allowed values are 'ordered' (default) and 'eager'. If you use this attribute, you must also define concurrency_group and concurrency.

dependsOn