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

Trigger

open class Trigger : Parametrized, Validatable

Represents TeamCity build trigger. Use concrete trigger classes such as VcsTrigger instead of this class.

Example. VCS trigger which triggers builds only in the default branch

See also Vcs Trigger

triggers {
    vcs {
        branchFilter = "+:<default>"
    }
}

Example. Schedule trigger executing once per day at 9AM

See also Schedule Trigger

triggers {
    schedule {
        schedulingPolicy = daily {
            hour = 9
        }
        triggerBuild = always()
        withPendingChangesOnly = false
    }
}

Example. Retry build with build customization.

Retries a failed build with the same settings and the same revisions. See also Retry build trigger

triggers {
    retryBuild {
        attempts = 2
        retryWithTheSameRevisions = true

        enforceCleanCheckout = true
        enforceCleanCheckoutForDependencies = true
        buildParams {
            param("param1", "value1")
            param("param2", "%build.number%")
        }
    }
}

Inheritors

MavenArtifactDependencyTrigger

MavenSnapshotDependencyTrigger

FinishBuildTrigger

RetryBuildTrigger

ScheduleTrigger

NuGetDependency

GitHubChecksTrigger

PerforceShelveTrigger

BranchRemoteRunTrigger

Constructors

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

Creates a trigger and initializes it with the specified init block

constructor()

Properties

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

var enabled: Boolean

Specifies whether the trigger is enabled

enforceCleanCheckout

var enforceCleanCheckout: Boolean

Whether the build should be triggered with clean checkout

enforceCleanCheckoutForDependencies

var enforceCleanCheckoutForDependencies: Boolean

When the enforceCleanCheckout is set to true specifies whether the clean checkout should also be applied to all dependencies.

var id: String?

Trigger id, if not set will be generated

val params: List<Parameter>

var type: String

Trigger type

Functions

booleanParameter

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

fun buildParams(init: TriggerBuildParameters.() -> Unit)

Configures build parameters that are applied to triggered builds

fun clear()

clearBuildParams

fun clearBuildParams()

Deletes all configured build parameters

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(): Trigger

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