TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.projectFeatures/VersionedSettings

VersionedSettings

open class VersionedSettings : ProjectFeature

fun ProjectFeatures.versionedSettings(init: VersionedSettings.() -> Unit): VersionedSettings

Project feature enabling versioned settings in the project. This project feature is created only for projects with obsolete non-portable Kotlin DSL.

Example. Adds a versioned settings project feature for project with obsolete non-portable Kotlin DSL.

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        versionedSettings {
            id = "VersionedSettings"
            mode = VersionedSettings.Mode.ENABLED
            buildSettingsMode = VersionedSettings.BuildSettingsMode.USE_CURRENT_SETTINGS
            rootExtId = "${<DslVcsRoot>.id}"
            showChanges = false
            settingsFormat = VersionedSettings.Format.KOTLIN
            storeSecureParamsOutsideOfVcs = true
        }
Content copied to clipboard
    }
}

Constructors

VersionedSettings

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

VersionedSettings

fun VersionedSettings()

Types

BuildSettingsMode

enum BuildSettingsMode : Enum<VersionedSettings.BuildSettingsMode>

Specifies what settings to use for builds

Format

enum Format : Enum<VersionedSettings.Format>

Versioned settings format

Mode

enum Mode : Enum<VersionedSettings.Mode>

Versioned settings mode

Functions

booleanParameter

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

clear

fun clear()

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): ProjectFeature

Creates an instance of this project 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><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

allowEditingOfProjectSettings

var allowEditingOfProjectSettings: <ERROR CLASS>

If set to true then the project/build configuration settings can be modified via the user interface or REST API and changes will be checked into the settings repository. If set to false then the project settings can be modified only via the settings repository.

buildSettingsMode

var buildSettingsMode: <ERROR CLASS>

Specifies what settings to use for builds

var id: String? = null

Project feature id, if not specified will be generated

mode

var mode: <ERROR CLASS>

Versioned settings mode to use

params

val params: List<Parameter>

rootExtId

var rootExtId: <ERROR CLASS>

Id of the VCS root where project settings are stored

settingsFormat

var settingsFormat: <ERROR CLASS>

Project settings format name.

showChanges

var showChanges: <ERROR CLASS>

Whether settings changes should be shown in builds when a settings VCS root is not attached to a build configuration.

storeSecureParamsOutsideOfVcs

var storeSecureParamsOutsideOfVcs: <ERROR CLASS>

Specifies how secure parameters should be stored. When set to true, parameters are stored outside of version control. When set to false, parameters are scrambled and stored in version control.

type

var type: String

Project feature type

VersionedSettings

See also

Constructors

Types

Functions

Properties