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

PerforceShelveTrigger

open class PerforceShelveTrigger : Trigger

fun Triggers.perforceShelveTrigger(init: PerforceShelveTrigger.() -> Unit): PerforceShelveTrigger

Perforce Shelve Trigger queues a build when a shelved changelist is created/updated in the VCS Root of the build configuration.

Example. Configure a Perforce Shelve Trigger which runs a personal build when a new or modified shelved changelist is detected. The shelved changelist must have #review keyword in its description. The build will enforce clean checkout, and will have an extra inShelve=true configuration parameter.

object Docker : BuildType({
    name = "Test build for shelves"
    ...
    triggers {
        perforceShelveTrigger {
            keyword = "#review"

            enforceCleanCheckout = true
            buildParams {
                param("inShelve", "true")
            }
        }
    }
})

Constructors

PerforceShelveTrigger

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

constructor()

Properties

buildParams

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

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

keyword

var keyword: String?

The keyword which should be present in Perforce shelved changelist description to trigger the build. Default keyword is #teamcity

params

val params: List<Parameter>

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