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

ScheduleTrigger

fun Triggers.schedule(init: ScheduleTrigger.() -> Unit): ScheduleTrigger

Base class for Schedule Build Triggers. Schedule trigger runs builds by specified schedule.

Example. Trigger a build every day at 10AM even if there are no pending changes.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        schedule {
          schedulingPolicy = daily {
            hour = 10
          }
          withPendingChangesOnly = false
          triggerBuild = always()
        }
Content copied to clipboard
    }
}

Example. Check for pending changes twice per hour in branches with name starting with 'feature/' and trigger builds there if pending changes found.

/*

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        schedule {
          schedulingPolicy = cron {
            minutes = "*/30"
           }

           branchFilter = "+:feature/*"
           withPendingChangesOnly = true
           triggerBuild = always()
         }
Content copied to clipboard
    }
}

*/

Example. Trigger a build every day at 10AM but only if there is a freshly finished build in a build configuration with id "MyApp". See also build changes.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        schedule {
          schedulingPolicy = daily {
            hour = 10
          }

          withPendingChangesOnly = false
          triggerBuild = onWatchedBuildChange {
            buildType = "MyApp"
          }
        }
Content copied to clipboard
    }
}

Example. Trigger a build at 10AM every day with an additional parameter "release" set to "true". See also triggered build customization.

buildType {
    // Other Build Type settings ...
    triggers {
        // Other Triggers ...
        schedule {
          schedulingPolicy = daily {
            hour = 10
          }
          triggerBuild = always()
          withPendingChangesOnly = false

          buildParams {
            param("release", "true")
          }
        }
Content copied to clipboard
    }
}

Constructors

ScheduleTrigger

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

constructor()

Types

DAY

enum DAY : Enum<ScheduleTrigger.DAY>

SchedulingPolicy

sealed class SchedulingPolicy : CompoundParam<ScheduleTrigger.SchedulingPolicy>

TriggerBuild

sealed class TriggerBuild : CompoundParam<ScheduleTrigger.TriggerBuild>

WatchedBuildRule

enum WatchedBuildRule : Enum<ScheduleTrigger.WatchedBuildRule>

Specifies which build to watch

Properties

branchFilter

var branchFilter: String?

Branch filter specifies set of branches where build should be triggered

buildParams

val buildParams: TriggerBuildParameters

Parameters that are added to triggered builds

enabled

var enabled: Boolean

Specifies whether the trigger is enabled

enableQueueOptimization

var enableQueueOptimization: Boolean?

Whether the trigger should allow builds optimization in the build queue. By default optimization 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>

schedulingPolicy

var schedulingPolicy: ScheduleTrigger.SchedulingPolicy?

Specifies when the build should be triggered. Use daily, weekly, or cron methods to specify it.

triggerBuild

var triggerBuild: ScheduleTrigger.TriggerBuild?

Specifies whether build should be triggered only when the specified watched build changes. Use always, or onWatchedBuildChange methods to specify it.

triggerBuildOnAllCompatibleAgents

var triggerBuildOnAllCompatibleAgents: Boolean?

When this option is enabled the build will be triggered on all enabled compatible agents

triggerRules

var triggerRules: String?

Specifies trigger rules

type

var type: String

Trigger type

withPendingChangesOnly

var withPendingChangesOnly: Boolean?

Whether the trigger should run build only when there are pending changes in the build configuration

Functions

always

fun always(): ScheduleTrigger.TriggerBuild.Always

Don't watch any build, trigger build using the specified schedule

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.

cron