TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.vcs/SvnVcsRoot

SvnVcsRoot

A Subversion VCS root

Example. Defines a Subversion VCS root MyVcsRoot with authentication by an SSH key and registers it in the project and a build configuration. The VCS Root fully supports SVN externals.

project {
  ...
  vcsRoot(MyVcsRoot)

  buildType {
    id = "MyBuild"
    name = "MyBuild"

    vcs {
      root(MyVcsRoot)
    }
  ...
  }
  ...
}

object MyVcsRoot : SvnVcsRoot({
    name = "Non-migrated libraries"
    url = "svn+ssh://svn@my-host.my.net/home/svn/repo"
    userName = "svn"
    customSshKey = "/home/tc/.ssh/id_rsa"
    externalsMode = SvnVcsRoot.ExternalsMode.FULL_SUPPORT

    pollInterval = 600 // seconds
})

Constructors

SvnVcsRoot

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

constructor()

Types

ExternalsMode

enum ExternalsMode : Enum<SvnVcsRoot.ExternalsMode>

Subversion externals mode

WorkingCopyFormat

enum WorkingCopyFormat : Enum<SvnVcsRoot.WorkingCopyFormat>

A Subversion working copy format

Properties

configDir

var configDir: String?

Custom Subversion configuration directory to use

customSshKey

var customSshKey: String?

A path to SSH key on the TeamCity server machine to use

enableNonTrustedSSL

var enableNonTrustedSSL: Boolean?

Whether TeamCity should accept non-trusted SSL certificates from Subversion server

enforceRevert

var enforceRevert: Boolean?

If true, TeamCity will always run svn revert before updating sources

externalsMode

var externalsMode: SvnVcsRoot.ExternalsMode?

A mode of externals support

open override var id: Id?

VCS root id. It appears in the web UI and is used in urls. If the VCS root has a uuid specified, then the id can be changed at any time. If uuid is omitted, then TeamCity treats a VCS root with a changed id as a new VCS root, all data associated with the old root will be lost (e.g. a commits graph). Id can also be used by some settings, e.g. as a part of parameter reference. If you change the id, you should find all its occurrences in the current project and change them too. Id must be unique across all VCS roots on the server. If id is missing, it will be generated from the class name (if the class is not from the jetbrains.buildServer.configs.kotlin package).

labelingMessage

var labelingMessage: String?

A message to use for labeling

labelingRules

var labelingRules: String?

Labeling patterns to use

name

var name: String

VCS root name

paramRefs

open val paramRefs: VcsRootRefs

Helper for creating references to parameters of this VCS root

params

val params: List<Parameter>

passphrase

var passphrase: String?

A passphrase for SSH key if it is encrypted

password

var password: String?

A password for Subversion connection

pollInterval

var pollInterval: Int?

VCS root polling interval, in seconds

sshPort

var sshPort: Int?

SSH port to use

type

var type: String

VCS type

uploadedKey

var uploadedKey: String?

Name of the uploaded SSH key to use for connections via SSH.

url

var url: String?

Subversion server URL

useDefaultConfigDir

var useDefaultConfigDir: Boolean?

Whether the default Subversion configuration directory should be used

userName

var userName: String?

A username for Subversion connection

uuid

var uuid: String

VCS root uuid. TeamCity uses it to identify the VCS root. If uuid changes, TeamCity considers it to be a new entity. If uuid is missing, it is reconstructed from VCS root id. Uuid must be unique across all entities on the server.

workingCopyFormat

var workingCopyFormat: SvnVcsRoot.WorkingCopyFormat?

Subversion working copy format to use

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

Creates an instance of this VCS root 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): DelegateProvider<Double>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): DelegateProvider<E>

equals

open operator override fun equals(other: Any?): Boolean

findRawParam

fun findRawParam(paramName: String): Parameter?

hashCode

open override fun hashCode(): Int

hasParam

fun hasParam(paramName: String): Boolean

fun id(id: String)

Sets the id to the specified value. Type of the id depends on the context in which DSL is executed: it is RelativeId when DSL context is relative, otherwise it is AbsoluteId.

intParameter

fun intParameter(customName: String? = null): DelegateProvider<Int>

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): DelegateProvider<String>

toString

open override fun toString(): String

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer