Package jetbrains.buildServer.vcs

Interface VcsRootIdentityProvider

All Superinterfaces:

VcsExtension, VcsService

All Known Implementing Classes:

MockBranchSupport, MockVcsSupport

public interface VcsRootIdentityProvider
extends VcsExtension, VcsService

VcsSupportCore should implement this interface to provide a string which can be treated as a VCS root identity and used by core to compare different VCS roots, e.g. when making a decision to reuse already calculated current state instead of requesting it from a VCS plugin

Since:

2022.1

See Also:

VcsSupportCore

Method Summary

Modifier and Type	Method	Description
String	getDefaultBranchName(VcsRoot vcsRoot)
String	getVcsRootIdentity(VcsRoot vcsRoot)	For the provided VCS root calculate identity, which can be used by TeamCity core to decide if two VCS root represent the same or different repositories

Method Detail

getVcsRootIdentity

@NotNull
String getVcsRootIdentity(@NotNull
                          VcsRoot vcsRoot)
                   throws VcsException

For the provided VCS root calculate identity, which can be used by TeamCity core to decide if two VCS root represent the same or different repositories

Parameters:

vcsRoot - VCS Root to get identity for

Returns:

see above

Throws:

VcsException - in case of VCS problem

getDefaultBranchName

@Nullable
String getDefaultBranchName(@NotNull
                            VcsRoot vcsRoot)

Returns:

which branch should be treated as default to be used by TeamCity core e.g. to compare current states or null if not applicable