com.atlassian.bamboo.plan.branch
Interface BranchIntegrationConfiguration

All Superinterfaces:
ConvertibleFromConfig, OptionallyConvertibleFromConfig, java.io.Serializable
All Known Implementing Classes:
BranchIntegrationConfigurationImpl

public interface BranchIntegrationConfiguration
extends OptionallyConvertibleFromConfig, java.io.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
 PlanKey getBranchToMergeWith(PlanKey featureBranch)
          Returns the PlanKey of the relevant vcs branch we want to merge with.
 PlanKey getIntegrationPlanBranchKey()
           
 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
 

Method Detail

isEnabled

boolean isEnabled()

getStrategy

@Nullable
BranchIntegrationStrategy getStrategy()

getIntegrationPlanBranchKey

@NotNull
PlanKey getIntegrationPlanBranchKey()

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

@NotNull
PlanKey getBranchToMergeWith(@NotNull
                                     PlanKey featureBranch)
Returns the PlanKey of the relevant vcs branch we want to merge with. In Hg/Git/SVN terms, this will be the VCS branch we merge with after checkout.



Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.