Git [VCS root](https://www.jetbrains.com/help/teamcity/?Git) Repository url Custom repository push url. If not specified then the url specified in the url property is used for push operations. @see url The default branch name [Branch specification](https://www.jetbrains.com/help/teamcity/?Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec) to use in VCS root When enabled tags matched by branch specification will be shown in UI as regular branches. By default false. Defines how TeamCity retrieves [VCS username](https://www.jetbrains.com/help/teamcity/?Managing+Users+and+User+Groups#ManagingUsersandUserGroups-vcsUsername) from git commit. @see UserNameStyle Whether VCS root should include changes in submodules and check their sources for build. By default submodules are checked out. @see CheckoutSubmodules A username for tag/merge operations in this VCS root. Format: Username <email> Whether TeamCity should convert line-endings of all text files to CRLF during server-side checkout. By default false. Custom path to git executable on the build agent machine Specifies when the "git clean" command should be executed in case of agent-side checkout @see AgentCleanPolicy Specifies which files should be removed when "git clean" command is executed during agent-side checkout. @see AgentCleanFilesPolicy Use checkoutPolicy parameter instead. Corresponding values are NO_MIRRORS for false and USE_MIRRORS for true (default value, can be ommitted). 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. Policy for checking out sources on agent VCS Root authentication method Anonymous repository access Password authentication Username to use, overwrites the username in the url Password to use Uploaded [SSH key](https://www.jetbrains.com/help/teamcity/?SSH+Keys+Management) with the specified name. Username to use, overwrites the username in the url Name of the uploaded [SSH key](https://www.jetbrains.com/help/teamcity/?SSH+Keys+Management) to use Passphrase for the uploaded [SSH key](https://www.jetbrains.com/help/teamcity/?SSH+Keys+Management). Leave it empty if the key is not encrypted. 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. @see uploadedKey Username to use, overwrites the username in the url 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. @see uploadedKey Username to use, overwrites the username in the url Path to the SSH key on TeamCity server machine Passphrase for the key. Leave it empty if the key is not encrypted. Authentication with a refreshable token stored in TeamCity token storage Username to use with the token Compound id of a token in the token storage Defines how TeamCity retrieves [VCS username](https://www.jetbrains.com/help/teamcity/?Managing+Users+and+User+Groups#ManagingUsersandUserGroups-vcsUsername) from git commit. When the git config contains the following ``` [user] name = Joe Coder email = joe.coder@acme.com ``` then the git username in commit is `Joe Coder <joe.coder@acme.com>`. Different options specify which part of the git commit username is used in TeamCity. Use the name part, for full name `Joe Coder <joe.coder@acme.com>` it will be `Joe Coder` Use part of the email before the @ sign, for full name `Joe Coder <joe.coder@acme.com>` it will be `joe.coder` Use the email part, for full name `Joe Coder <joe.coder@acme.com>` it will be `joe.coder@acme.com` Use full commit username, i.e. `Joe Coder <joe.coder@acme.com>` Policy for checking out sources on agent Uses shallow clone for short-lived agents and mirrors for regular long-lived agents. Creates repository mirror on the agent machine and shares it between different builds with the same fetch URL. Most optimal approach for large repositories and long-lived agents. Performs checkout right into the checkout directory without creating a mirror. Less optimal in terms of disk usage than mirrors. Uses git shallow clone to checkout build revision (--depth 1). Ideal for short-lived agents. Submodules checkout mode Checkout submodules and show submodule changes in UI Don't checkout submodules and don't show changes from submodules in UI Checkout submodules non-recursively Specifies when the "git clean" command should be executed in case of agent-side checkout Don't run the "git clean" command Run the "git clean" command before each build Run the "git clean" command if the branch in build is different comparing to the branch in the previous build on same agent Specifies flags for the "git clean" command during agent-side checkout and defines which files will be removed. Will run "git clean -dfX" Will run "git clean -df" Will run "git clean -dfx" Defines a VCS root MyVcsRoot with authentication by an SSH key and registers it in the project and a build configuration. project { ... vcsRoot(MyVcsRoot) buildType{ id = "MyBuild" name = "MyBuild" vcs { root(MyVcsRoot) } ... } ... } object MyVcsRoot: GitVcsRoot({ name = "My project main repository" url = "<repository URL>" branch = "refs/heads/main" checkoutPolicy = AgentCheckoutPolicy.USE_MIRRORS authMethod = uploadedKey { uploadedKey = "<SSH key name>" } })