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

VcsLabeling

fun BuildFeatures.vcsLabeling(init: VcsLabeling.() -> Unit): VcsLabeling

Build feature enabling automatic VCS labeling in a build.

Example. Upon finishing of a successful build, add a tag with name 'teamcity-build-%system.build.number%' to the VCS repository of the VCS Root with specified id. Note: parameter reference %system.build.number% will be replaced with the build number of the build. See also predefined parameters.

buildType {
    // Other Build Type settings ...
    features {
        // Other Build Features ...
        vcsLabeling {
          vcsRootId = "< id of a VCS root>"
          labelingPattern = "teamcity-build-%system.build.number%"
          successfulOnly = true
        }



Content copied to clipboard
    }
}

Constructors

VcsLabeling

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

constructor()

Properties

branchFilter

var branchFilter: <Error class: unknown class>

Branch filter specifies in which branches sources should be labeled

enabled

var enabled: Boolean

Specifies whether the feature is enabled, true by default

var id: String?

Build feature id, if not specified will be generated

labelingPattern

var labelingPattern: <Error class: unknown class>

A pattern for labels to use. If not specified, then the default pattern is used: build-%system.build.number%.

params

val params: List<Parameter>

successfulOnly

var successfulOnly: <Error class: unknown class>

Whether only successful builds sources should be labeled

type

var type: String

Build feature type

vcsRootExtId

var ~~vcsRootExtId~~: <Error class: unknown class>

Id of the VCS root which sources should be labeled. Use the constant "ALL" to label all VCS roots.

vcsRootId

var vcsRootId: <Error class: unknown class>

Id of the VCS root which sources should be labeled. Use the constant "ALL" to label all VCS roots.

Functions

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, 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

fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>

findRawParam