jetbrains.buildServer.configs.kotlin.v2018_1 / VcsSettings

VcsSettings

class VcsSettings

Contains settings from the Version Control Settings tab of build configuration or template.

Constructors

<init>

VcsSettings()

Contains settings from the Version Control Settings tab of build configuration or template.

Properties

branchFilter

var branchFilter: String

Defines branch filter to be used for branches coming from snapshot dependencies.

buildDefaultBranch

var buildDefaultBranch: Boolean

Whether builds in the default branch are allowed and the default branch is shown in UI. By default true.

checkoutDir

var checkoutDir: String

Custom build checkout directory. By default empty, ie. build uses default checkout directory.

checkoutMode

var checkoutMode: CheckoutMode

Defines a preferred checkout mode for the build.

cleanCheckout

var cleanCheckout: Boolean

If true, all files in build's working directory will be deleted before the build is started. By default false.

excludeDefaultBranchChanges

var excludeDefaultBranchChanges: Boolean

Whether changes reachable from the default branch should be excluded from other branches. By default false.

showDependenciesChanges

var showDependenciesChanges: Boolean

If true, build will include snapshot dependencies changes when reporting changes on UI. By default false

Functions

getEntry

fun getEntry(rootId: Id): VcsRootEntry?

option

fun option(name: String, value: String): Unit

Sets option with specified name and value

removeEntry

fun removeEntry(rootId: Id): Unit

root

fun root(root: VcsRoot, vararg rules: String): Unit

Attaches the specified VCS root with the given checkout rules to a template or buildType

fun root(rootId: Id, vararg rules: String): Unit

Attaches a VCS root with the specified id with the given checkout rules to a template or buildType. This method can be used to attach a VCS root which is not defined in Kotlin.

Extension Functions

copy

fun VcsSettings.copy(): VcsSettings

Copies the receiver vcs settings

copyTo

fun VcsSettings.copyTo(target: VcsSettings): VcsSettings

Copies the receiver vcs settings to the specified target