com.atlassian.bamboo.plan.branch

Interface BranchIntegrationConfiguration

All Superinterfaces:

ConfigurationMergingCapable, ConvertibleFromConfig, OptionallyConvertibleFromConfig, Serializable

All Known Implementing Classes:

BranchIntegrationConfigurationImpl

public interface BranchIntegrationConfiguration
extends OptionallyConvertibleFromConfig, ConfigurationMergingCapable, Serializable

This interface is used to store branch "integration strategy" settings - the thing that does the merge with an arbitrary branch (so called 'integration branch') prior to executing the jobs, and pushing the merge commit back to the repository after successful build.

Method Summary

Modifier and Type	Method and Description
String	findBranchToMergeWith(PlanKey featureBranch) Returns the PlanKey or branch name of the relevant vcs branch we want to merge with.
PlanKey	getBranchToMergeWith(PlanKey featureBranch) Deprecated. since 6.0. Use findBranchToMergeWith(PlanKey)
PlanKey	getIntegrationPlanBranchKey() Deprecated. since 6.0. Use getIntegrationPoint().
BranchIntegrationPoint	getIntegrationPoint()
PlanKey	getMergeResultDestinationBranch(PlanKey featureBranch) Returns the PlanKey of the relevant VCS branch we want to perform the merge on.
BranchIntegrationStrategy	getStrategy()
boolean	isEnabled()
boolean	isPushEnabled() Tells whether Bamboo should push back the merged commit back into upstream repository if the build finishes successfully.

Methods inherited from interface com.atlassian.bamboo.fieldvalue.OptionallyConvertibleFromConfig

isValid

Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConvertibleFromConfig

populateFromConfig, toConfiguration

Methods inherited from interface com.atlassian.bamboo.fieldvalue.ConfigurationMergingCapable

toConfiguration

Method Detail

isEnabled

boolean isEnabled()

getStrategy

@Nullable
BranchIntegrationStrategy getStrategy()

getIntegrationPlanBranchKey

@Deprecated
 @Nullable
PlanKey getIntegrationPlanBranchKey()

Deprecated. since 6.0. Use getIntegrationPoint().

getIntegrationPoint

@NotNull
BranchIntegrationPoint getIntegrationPoint()

isPushEnabled

boolean isPushEnabled()

Tells whether Bamboo should push back the merged commit back into upstream repository if the build finishes successfully.

getMergeResultDestinationBranch

@NotNull
PlanKey getMergeResultDestinationBranch(@NotNull
                                                 PlanKey featureBranch)

Returns the PlanKey of the relevant VCS branch we want to perform the merge on. In Hg/Git/SVN terms, this will be the VCS branch we checkout prior to merge.

getBranchToMergeWith

@Deprecated
 @Nullable
PlanKey getBranchToMergeWith(@NotNull
                                                    PlanKey featureBranch)

Deprecated. since 6.0. Use findBranchToMergeWith(PlanKey)

Returns the PlanKey we want to merge with. Used only for debug messages In Hg/Git/SVN terms, this will be the VCS branch we merge with after checkout.

findBranchToMergeWith

@NotNull
String findBranchToMergeWith(@NotNull
                                      PlanKey featureBranch)

Returns the PlanKey or branch name of the relevant vcs branch we want to merge with. Used only for debug messages In Hg/Git/SVN terms, this will be the VCS branch we merge with after checkout.