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

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

See also

Constructors

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

Properties

Link copied to clipboard

Optional collection of build step execution conditions

Link copied to clipboard

Specifies whether the step is enabled, true by default

Link copied to clipboard
Link copied to clipboard
var file: <Error class: unknown 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.

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

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

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

Build step type

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