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

DockerComposeStep

open class DockerComposeStep : BuildStep

fun BuildSteps.dockerCompose(init: DockerComposeStep.() -> Unit): DockerComposeStep

A build step for docker-compose step.

Example. Adds a Docker Compose build step with specified Compose YAML file.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dockerCompose {
            name = "My Compose"
            file = "my-services.yml"
        }
Content copied to clipboard
    }
}

Example. Adds a Docker Compose build step with multiple Compose YAML files, separated by space. Option for explicitly pull images is enabled. This step will we executed only if build status is sucessfull for previous build steps and extra condition is met.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        dockerCompose {
            name = "My Compose"

            executionMode = BuildStep.ExecutionMode.RUN_ON_SUCCESS
            conditions {
                equals("teamcity.build.branch", "release")
            }

            file = "my-services.yml my-other-services.yml"
            forcePull = true
        }
Content copied to clipboard
    }
}

Constructors

DockerComposeStep

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

DockerComposeStep

fun DockerComposeStep()

Functions

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

file

var file: <ERROR CLASS>

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: <ERROR CLASS>

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

var id: String? = null

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>

type

var type: String

Build step type

DockerComposeStep

See also

Constructors

Functions

Properties