TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildFeatures/Notifications

Notifications

fun BuildFeatures.notifications(init: Notifications.() -> Unit): Notifications

Build feature for notification rule

Example. Adds notifications build feature that sends email notifications when build is started

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        notifications {
            notifierSettings = emailNotifier {
                email = "me@mail.com"
            }

            buildStarted = true
        }
Content copied to clipboard
    }
}

Example. Adds notifications build feature that sends email notifications when build is finished successfully

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        notifications {
            notifierSettings = emailNotifier {
                email = "me@mail.com"
            }

            buildFinishedSuccessfully = true
        }
Content copied to clipboard
    }
}

Example. Adds notifications build feature that sends email notifications when build failed, but only in "main" branch

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        notifications {
            notifierSettings = emailNotifier {
                email = "me@mail.com"
            }

            branchFilter = "+:main"
            buildFailed = true
        }
Content copied to clipboard
    }
}

Constructors

Notifications

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

Notifications

fun Notifications()

Types

NotifierSettings

sealed class NotifierSettings : CompoundParam<Notifications.NotifierSettings>

Functions

booleanParameter

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

clear

fun clear()

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

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