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

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

constructor()

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

Properties

allowEditingOfProjectSettings

var allowEditingOfProjectSettings: Boolean?

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: VersionedSettings.BuildSettingsMode?

Specifies what settings to use for builds

var id: String?

Project feature id, if not specified will be generated

mode

var mode: VersionedSettings.Mode?

Versioned settings mode to use

params

val params: List<Parameter>

path

var path: String?

Specify a directory for versioned project settings. Custom directories enable distinct settings for different projects targeting the same VCS repository. If this setting is empty, the default directory will be used. Enter "." to save settings directly to the repository root. Be aware, TeamCity may clear the target directory before uploading new files. Use "." solely for repositories that should store nothing but TeamCity project settings.

rootExtId

var rootExtId: String?

Id of the VCS root where project settings are stored

settingsFormat

var settingsFormat: VersionedSettings.Format?

Project settings format name.

showChanges

var showChanges: Boolean?

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

storeSecureParamsOutsideOfVcs

var storeSecureParamsOutsideOfVcs: Boolean?

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

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