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

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

constructor()

Types

NotifierSettings

sealed class NotifierSettings : CompoundParam<Notifications.NotifierSettings>

Properties

branchFilter

var branchFilter: String?

Branch filter

buildFailed

var buildFailed: Boolean?

Send notification if build failed

buildFailedToStart

var buildFailedToStart: Boolean?

Send notification if build fails to start

buildFinishedSuccessfully

var buildFinishedSuccessfully: Boolean?

Send notification if build finished successfully

buildProbablyHanging

var buildProbablyHanging: Boolean?

Build is probably hanging

buildStarted

var buildStarted: Boolean?

Send notification when build started

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

firstBuildErrorOccurs

var firstBuildErrorOccurs: Boolean?

Notify when the first build error occurs

firstFailureAfterSuccess

var firstFailureAfterSuccess: Boolean?

Send notification if build failed for the first time after success

firstSuccessAfterFailure

var firstSuccessAfterFailure: Boolean?

Send notification if build is successfull for the first time after failure

var id: String?

Build feature id, if not specified will be generated

newBuildProblemOccured

var ~~newBuildProblemOccured~~: Boolean?

Only notify on new build problem or new failed test

newBuildProblemOccurred

var newBuildProblemOccurred: Boolean?

Only notify on new build problem or new failed test

notifier

var ~~notifier~~: String?

Notifier that will send notifications

notifierSettings

var notifierSettings: Notifications.NotifierSettings?

Notifier that will send notifications

notifyUntilBuildIsComplete

var notifyUntilBuildIsComplete: Boolean?

Keep notifying until build is complete (even without my changes)

params

val params: List<Parameter>

queuedBuildRequiresApproval

var queuedBuildRequiresApproval: Boolean?

Queued build requires approval

type

var type: String

Build feature type

Functions

booleanParameter

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

clear

fun clear()

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