TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin/MatrixFeature

MatrixFeature

fun BuildFeatures.matrix(init: MatrixFeature.() -> Unit = {})

The Matrix Builds feature allows you to define a build configuration with different sets of parameters/parameter values. Running this build configuration creates a batch of separate builds, each running its own parameter set.

Example: The following snippet sets up the Matrix Build feature that produces 12 individual builds — one for each combination of available operating systems, Docker images, and Database images.

features {
    matrix {
        os = listOf(
            value("Linux"),
            value("Windows"),
            value("Mac OS")
        )
        param("docker.image", listOf(
            value("python:3.9.18-bullseye", label = "3.9.18"),
            value("python:3.12.Orc2-slim", label = "3.12.0")
        ))
        param("database.image", listOf(
            value("postgres:16rc1"),
            value("postgres:13.12")
        ))
    }
}

Constructors

MatrixFeature

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

Types

Companion

object Companion

Value

data class Value(val value: String, val label: String? = null)

Properties

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

var os: List<MatrixFeature.Value>?

Operating systems

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