jetbrains.buildServer.configs.kotlin.v10.vcs / GitVcsRoot

GitVcsRoot

open class GitVcsRoot : VcsRoot

Git VCS root

Types

AgentCleanFilesPolicy

enum class AgentCleanFilesPolicy

Specifies flags for the "git clean" command during agent-side checkout and defines which files will be removed.

AgentCleanPolicy

enum class AgentCleanPolicy

Specifies when the "git clean" command should be executed in case of agent-side checkout

AuthMethod

sealed class AuthMethod : CompoundParam

CheckoutSubmodules

enum class CheckoutSubmodules

Submodules checkout mode

UserNameStyle

enum class UserNameStyle

Defines how TeamCity retrieves VCS username from git commit. When the git config contains the following

Constructors

<init>

GitVcsRoot(init: GitVcsRoot.() -> Unit = {}, base: GitVcsRoot? = null)

Properties

agentCleanFilesPolicy

var agentCleanFilesPolicy: AgentCleanFilesPolicy?

Specifies which files should be removed when "git clean" command is executed during agent-side checkout.

agentCleanPolicy

var agentCleanPolicy: AgentCleanPolicy?

Specifies when the "git clean" command should be executed in case of agent-side checkout

agentGitPath

var agentGitPath: String?

Custom path to git executable on the build agent machine

authMethod

var authMethod: AuthMethod?

VCS Root authentication method

branch

var branch: String?

The default branch name

branchSpec

var branchSpec: String?

Branch specification to use in VCS root

checkoutSubmodules

var checkoutSubmodules: CheckoutSubmodules?

Whether VCS root should include changes in submodules and check their sources for build. By default submodules are checked out.

pushUrl

var pushUrl: String?

Custom repository push url. If not specified then the url specified in the url property is used for push operations.

serverSideAutoCRLF

var serverSideAutoCRLF: Boolean?

Whether TeamCity should convert line-endings of all text files to CRLF during server-side checkout. By default false.

url

var url: String?

Repository url

useMirrors

var useMirrors: Boolean?

When this option is enabled, TeamCity creates a separate clone of the repository on each agent and uses it in the checkout directory via git alternates. This make agent-side checkout faster. By default true.

useTagsAsBranches

var useTagsAsBranches: Boolean?

When enabled tags matched by branch specification will be shown in UI as regular branches. By default false.

userForTags

var userForTags: String?

A username for tag/merge operations in this VCS root. Format: Username

userNameStyle

var userNameStyle: UserNameStyle?

Defines how TeamCity retrieves VCS username from git commit.

Inherited Properties

extId

var extId: String

VCS root external id. It appears in web UI and is used in urls. Can be changed at any time. But be aware that some settings use it, e.g. as a part of parameter reference. If you change the extId, you should find all its occurrences in the current project and change them too.

name

var name: String

VCS root name

pollInterval

var pollInterval: Int?

VCS root polling interval

type

var type: String

VCS type

uuid

var uuid: String

VCS root uuid. It is mandatory, TeamCity uses it to identify entities. If root's uuid changes, TeamCity considers it to be a new VCS root.

Functions

anonymous

fun anonymous(): Anonymous

Anonymous repository access

customPrivateKey

fun customPrivateKey(init: CustomPrivateKey.() -> Unit = {}): CustomPrivateKey

SSH key on the specified path. Supported only for server-side checkout. Switch to uploaded SSH key if you want to use an agent-side checkout.

defaultPrivateKey

fun defaultPrivateKey(init: DefaultPrivateKey.() -> Unit = {}): DefaultPrivateKey

Default SSH key found on the machine. If you use an agent-side checkout, then this key should also be available on the build agent machines. Often it is easier to use the uploaded SSH key.

password

fun password(init: Password.() -> Unit = {}): Password

Password authentication

uploadedKey

fun uploadedKey(init: UploadedKey.() -> Unit = {}): UploadedKey

Uploaded SSH key with the specified name.