VcsLabeling

open class VcsLabeling : BuildFeature
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
        }
} }

See also

Constructors

Link copied to clipboard
fun VcsLabeling(init: VcsLabeling.() -> Unit)
Link copied to clipboard
fun VcsLabeling()

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard
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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

Link copied to clipboard
var branchFilter: <ERROR CLASS>

Branch filter specifies in which branches sources should be labeled

Link copied to clipboard
var enabled: Boolean = true

Specifies whether the feature is enabled, true by default

Link copied to clipboard
var id: String? = null

Build feature id, if not specified will be generated

Link copied to clipboard
var labelingPattern: <ERROR CLASS>

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

Link copied to clipboard
val params: List<Parameter>
Link copied to clipboard
var successfulOnly: <ERROR CLASS>

Whether only successful builds sources should be labeled

Link copied to clipboard
var type: String

Build feature type

Link copied to clipboard
var vcsRootExtId: <ERROR CLASS>

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

Link copied to clipboard
var vcsRootId: <ERROR CLASS>

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