TeamCity Kotlin DSL 2025.03.3/jetbrains.buildServer.configs.kotlin.buildFeatures/Approval

Approval

fun BuildFeatures.approval(init: Approval.() -> Unit): Approval

Build feature that allows to request manual approve before build starts

Example. Do not start a build until at least one user from the user group with key 'STAGING_ADMIN' approves it. Wait for approval for 15 minutes, then cancel the build.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        approval {
          approvalRules = "group:STAGING_ADMIN:1"
          timeout = 15
        }
Content copied to clipboard
    }
}

Constructors

Approval

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

constructor()

Properties

approvalRules

var approvalRules: String?

Set of newline-separated approval rules; supported rules syntax: "user:username", "group:groupKey:requiredApprovalsCount"

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

manualRunsApproved

var manualRunsApproved: Boolean?

If started by user with sufficient permissions, mark build as approved by user

params

val params: List<Parameter>

timeout

var timeout: Int?

Amount of time (in minutes) before the build is cancelled, defaults to 6 hours

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