TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.triggers/FinishBuildTrigger

FinishBuildTrigger

fun Triggers.finishBuildTrigger(init: FinishBuildTrigger.() -> Unit): FinishBuildTrigger

Base class for Finish Build Triggers. Finish build trigger runs build when some other build finishes.

Example. Trigger a build if a new finished build or builds appear in the history of the build configuration with the specified id and with the branch starting with 'release/' prefix.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        finishBuildTrigger {
          buildType = "<id of a build configuration>"
          branchFilter = "+:release/*"
        }
Content copied to clipboard
    }
}

*/

Constructors

FinishBuildTrigger

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

constructor()

Properties

branchFilter

var branchFilter: String?

Branch filter allows to limit the branches where finished builds are watched.

buildParams

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

buildType

var buildType: String?

Id of the build configuration to watch. A new build will be triggered when a build in the watched build configuration is finished.

buildTypeExtId

var ~~buildTypeExtId~~: String?

Use buildType instead

enabled

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

params

val params: List<Parameter>

successfulOnly

var successfulOnly: Boolean?

Whether the build should be triggered only after a successful build in the watched build configuration

type

var type: String

Trigger type

Functions

booleanParameter

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

buildParams

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

Configures build parameters that are applied to triggered builds

clear

fun clear()

clearBuildParams

fun clearBuildParams()

Deletes all configured build parameters

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