jetbrains.buildServer.configs.kotlin.v2019_2.buildSteps / DockerComposeStep

DockerComposeStep

open class DockerComposeStep : BuildStep

A build step for docker-compose step.

See Also

dockerCompose

Constructors

<init>

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

A build step for docker-compose step.

Properties

file

var file: String?

TeamCity will start docker-compose services from the file in this step, and will shut down the services at the end of the build.

forcePull

var forcePull: Boolean?

If enabled, "docker-compose pull" will be run before "docker-compose up" command.

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