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

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

ScheduleTrigger

fun ScheduleTrigger()

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

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"): SingleDelegateProvider<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): CompoundDelegateProvider<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