TeamCity Kotlin DSL 2025.03.1

TeamCity Kotlin DSL 2025.03.1/jetbrains.buildServer.configs.kotlin/BuildFeature

BuildFeature

open class BuildFeature : Parametrized, Validatable

Represents TeamCity build feature. Use concrete build feature classes such as XmlReport instead of this class.

Example. Add approval to the build

See also Approval

features {
    approval {
        approvalRules = "user:qa"
    }
}

Example. Import test results into TeamCity from the JUnix test results XML files

See also XML report processing

features {
    xmlReport {
        reportType = XmlReport.XmlReportType.JUNIT
        rules = "test-reports/**.xml"
    }
}

*/

Inheritors

Constructors

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

Creates a build feature and initializes it with the specified init block

constructor()

Properties

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

val params: List<Parameter>

var type: String

Build feature type

Functions

booleanParameter

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

fun clear()

compoundParameter

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

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

Copies parameters of this object to the specified target

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

fun doubleParameter(customName: String? = null): DelegateProvider<Double>

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

fun findRawParam(paramName: String): Parameter?

fun hasParam(paramName: String): Boolean

fun intParameter(customName: String? = null): DelegateProvider<Int>

fun param(name: String, value: String)

Adds parameter with specified name and value

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): DelegateProvider<String>

open override fun toString(): String

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer