TeamCity Kotlin DSL 2025.03/jetbrains.buildServer.configs.kotlin.buildFeatures/RunInDockerBuildFeature

RunInDockerBuildFeature

open class RunInDockerBuildFeature : BuildFeature

fun BuildFeatures.runInDocker(init: RunInDockerBuildFeature.() -> Unit): RunInDockerBuildFeature

Runs all build steps of a configuration in the specified container. Steps that cannot run inside the container are executed outside of it. If the image registry requires authorization, enable the Docker Registry Connections build feature.

Example.

buildType {
    name = "Build in Docker"

    features {
        runInDocker {
            dockerImage = "busybox"
        }
    }

    steps {
        script {
            scriptContent = "echo this step is running inside the container"
        }
        script {
            scriptContent = "echo and this step is running in the same container""
        }
    }
}

Constructors

RunInDockerBuildFeature

constructor(init: RunInDockerBuildFeature.() -> Unit)

constructor()

Types

ImagePlatform

enum ImagePlatform : Enum<RunInDockerBuildFeature.ImagePlatform>

Docker image platforms

Properties

dockerImage

var dockerImage: String?

Image name to use for running build steps, for example, "ubuntu:latest". The image will be pulled via "docker pull" or "podman pull" commands, depending on which container manager is installed on the agent that runs the build.

dockerImagePlatform

var dockerImagePlatform: RunInDockerBuildFeature.ImagePlatform?

Select a specific image OS platform. Limits the pool of compatible agents to those running on this platform.

dockerPull

var dockerPull: Boolean?

If enabled, TeamCity will explicitly pull the target image every time the build is about to start.

dockerRunParameters

var dockerRunParameters: String?

Additional arguments passed to "docker run" command.

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

params

val params: List<Parameter>

type

var type: String

Build feature type

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildFeature

Creates an instance of this build feature 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