Package jetbrains.buildServer.serverSide

Interface BranchSpecProvider

All Superinterfaces:

ServerExtension, TeamCityExtension

All Known Implementing Classes:

RemoteRunBranchSpecProvider

public interface BranchSpecProvider
extends ServerExtension

Allows to extend a branch specification for VCS root in build configuration

Method Summary

Modifier and Type	Method	Description
Set<String>	getBranchesForChangesCollecting(BuildTypeEx buildType, VcsRootInstance root, VcsRepositoryState state)	Called during collecting changes for the VCS root.
Set<String>	getBranchSpecs(BuildTypeEx buildType, VcsRootInstance root, VcsRepositoryState state)	Called to calculate logical branch name from vcs branch name.
default boolean	includeIntoOwnBranchSpecsOf(BuildTypeEx buildType)	Returns true if branch specs supplied by the provider are to be included into the own branch specs of a VCS root instance by BuildTypeEx::getBranchSpec(VcsRootInstance).

Method Detail

getBranchSpecs

@NotNull
Set<String> getBranchSpecs(@NotNull
                           BuildTypeEx buildType,
                           @NotNull
                           VcsRootInstance root,
                           @NotNull
                           VcsRepositoryState state)

Called to calculate logical branch name from vcs branch name. Should return additional patterns for given buildType, VCS root and the state of the root.

Parameters:

buildType - buildType of interest

root - VCS root of interest

state - state of vcs root, state can be incomplete, e.g. contain a single branch of interest

Returns:

see above

getBranchesForChangesCollecting

@NotNull
Set<String> getBranchesForChangesCollecting(@NotNull
                                            BuildTypeEx buildType,
                                            @NotNull
                                            VcsRootInstance root,
                                            @NotNull
                                            VcsRepositoryState state)

Called during collecting changes for the VCS root. Should return additional branches where changes should be collected.

Parameters:

buildType - buildType of interest

root - VCS root of interest

state - full unfiltered current state of vcs root

Returns:

see above

includeIntoOwnBranchSpecsOf

default boolean includeIntoOwnBranchSpecsOf(@NotNull
                                            BuildTypeEx buildType)

Returns true if branch specs supplied by the provider are to be included into the own branch specs of a VCS root instance by BuildTypeEx::getBranchSpec(VcsRootInstance). False otherwise.

Parameters:

buildType -

Returns:

see above

Since:

2018.1