public interface BranchMonitoringConfiguration extends OptionallyConvertibleFromConfig, Serializable
Modifier and Type | Field and Description |
---|---|
static String |
BRANCH_CREATION_CONFIG_KEY |
static String |
BRANCH_TRIGGERING_CFG_KEY |
static String |
BRANCHES_CUSTOM_CONFIG_KEY |
static String |
BRANCHES_INACTIVITY_CLEAN_UP_PERIOD |
static String |
BRANCHES_MATCHING_PATTERN_CONFIG_KEY |
static String |
BRANCHES_MONITOR_PULL_REQUESTS_CONFIG_KEY |
static String |
BRANCHES_NOTIFICATION_STRATEGY_CONFIG_KEY |
static String |
DEFAULT_BRANCH_MATCH_NAME_PATTERN
Default pattern for vcs branch names to match, so Bamboo automatically creates a plan branch if enabled.
|
static int |
DEFAULT_REMOVED_BRANCH_CLEAN_UP_PERIOD
Sets the default number a days a plan branch will be deleted because its vcs branch has been deleted.
|
static int |
DEFAULT_TIME_OF_INACTIVITY_DAYS
Default inactivity period, that will be consider to evaluate if a branch is inactive (no commits in vcs branch).
|
static String |
INACTIVE_BRANCH_CLEANUP_CONFIG_KEY |
static String |
JIRA_BRANCH_LINKING_CONFIG_KEY |
static int |
MINIMUM_INACTIVE_BRANCH_CLEAN_UP_PERIOD
Sets the minimum number a days a a vcs branch will is considered inactive and therefore its plan branch will be deleted.
|
static int |
MINIMUM_REMOVED_BRANCH_CLEAN_UP_PERIOD
Sets the minimum number a days a plan branch will be deleted because its vcs branch has been deleted.
|
static String |
PLAN_BRANCHES_MONITORING_ENABLED
Deprecated.
since 5.9
|
static String |
REMOVED_BRANCH_CLEANUP_CONFIG_KEY |
static String |
REMOVED_BRANCH_CLEANUP_PERIOD_CONFIG_KEY |
static int |
REMOVED_BRANCH_DAILY_CLEAN_UP_PERIOD
Default period used for when cleaning of plan branches which vcs branch is removed happens daily,
which translates into as soon as the clean up job runs.
|
Modifier and Type | Method and Description |
---|---|
BranchTriggeringOption |
getBranchTriggeringOption() |
org.apache.commons.configuration.HierarchicalConfiguration |
getCustomConfiguration()
Return custom configuration related to branch detection in the particular plan.
|
BranchIntegrationConfiguration |
getDefaultBranchIntegrationConfiguration() |
BranchNotificationStrategy |
getDefaultBranchNotificationStrategy() |
int |
getInactiveBranchCleanUpPeriodInDays()
Returns a number of days the branch will be consider inactive (as per no commits activity in the repo) and therefore deleted.
|
String |
getMatchingPattern()
Returns the reg expression every vcs branch name needs to match for Bamboo to automatically create a plan branch for it.
|
int |
getRemovedBranchCleanUpPeriodInDays()
Returns a number of days the plan branch will be deleted once detected the vcs branch has been removed.
|
int |
getTimeOfInactivityInDays()
Deprecated.
since 5.9 use
getInactiveBranchCleanUpPeriodInDays() to determine the number of days, and
isInactiveBranchCleanUpEnabled() to determine if it is enabled. |
boolean |
isCleanupEnabled()
Deprecated.
since 5.9 use
isRemovedBranchCleanUpEnabled() instead to find out if branch cleanup is enabled
if the vcs branch is removed, and isInactiveBranchCleanUpEnabled() instead to find out if cleanup due
to inactivity is enabled. |
boolean |
isInactiveBranchCleanUpEnabled()
Returns if Bamboo is configured to automatically clean up plan branches for branches that are considered inactive.
|
boolean |
isMonitoringEnabled()
Deprecated.
since 5.9 use
isPlanBranchCreationEnabled() instead to find out if plan branch creation in enabled,
isRemovedBranchCleanUpEnabled() instead to find out if removed branch cleanup is enabled,
and isInactiveBranchCleanUpEnabled() ()} instead to find out if inactive plan branch cleanup is enabled. |
boolean |
isPlanBranchCreationEnabled()
Returns if Bamboo is configured to automatically create plan branches when detecting new branches in the repo.
|
boolean |
isRemoteJiraBranchLinkingEnabled()
Returns if Bamboo will attempt to create remote issue links in JIRA when it finds an issue key in the branch name.
|
boolean |
isRemovedBranchCleanUpEnabled()
Returns if Bamboo is configured to automatically clean up plan branches if the vcs branch is removed.
|
boolean |
monitorPullRequests()
Currently Bamboo does not handle plan branch monitoring by Pull Requests detection.
|
void |
setBranchTriggeringOption(BranchTriggeringOption branchTriggeringOption) |
void |
setCustomConfiguration(org.apache.commons.configuration.HierarchicalConfiguration customConfiguration) |
void |
setDefaultBranchIntegrationConfiguration(BranchIntegrationConfiguration defaultBranchIntegrationConfiguration) |
void |
setDefaultBranchNotificationStrategy(BranchNotificationStrategy branchNotificationStrategy) |
void |
setInactiveBranchCleanUpEnabled(boolean enabled)
Sets Bamboo to automatically cleanup plan branches if vcs branch is inactive.
|
void |
setInactiveBranchCleanUpPeriodInDays(int timeOfInactivityInDays)
Sets the number of days a plan branch will be consider inactive (as per no commits activity in the repo) and therefore deleted.
|
void |
setMatchingPattern(String regularExpression)
Sets the reg expression every vcs branch name will match for Bamboo to automatically create a plan branch for it.
|
void |
setMonitoringEnabled(boolean enabled)
Deprecated.
since 5.9 use
setPlanBranchCreationEnabled(boolean) instead to set up automatic plan branch creation,
and setRemovedBranchCleanUpEnabled(boolean) instead to set up automatic plan branch cleanup. |
void |
setMonitorPullRequests(boolean monitorPullRequests)
Currently Bamboo does not handle plan branch monitoring by Pull Requests detection.
|
void |
setPlanBranchCreationEnabled(boolean enabled)
Sets Bamboo to automatically create plan branches when detecting new branches in the repo.
|
void |
setRemoteJiraBranchLinkingEnabled(boolean remoteJiraBranchLinkingEnabled)
Sets if Bamboo will attempt to create remote issue links in JIRA when it finds an issue key in the branch name.
|
void |
setRemovedBranchCleanUpEnabled(boolean enabled)
Sets Bamboo to automatically cleanup plan branches if vcs branch is deleted.
|
void |
setRemovedBranchCleanUpPeriodInDays(int cleanUpPeriodInDays)
Sets the number of days a plan branch will be deleted once detected the vcs branch is removed.
|
void |
setTimeOfInactivityInDays(int timeOfInactivityInDays)
Deprecated.
since 5.9 use
getInactiveBranchCleanUpPeriodInDays() to determine the number of days, and
isInactiveBranchCleanUpEnabled() to determine if it is enabled. |
isValid
populateFromConfig, toConfiguration
@Deprecated static final String PLAN_BRANCHES_MONITORING_ENABLED
static final String BRANCH_CREATION_CONFIG_KEY
static final String BRANCHES_MATCHING_PATTERN_CONFIG_KEY
static final String REMOVED_BRANCH_CLEANUP_CONFIG_KEY
static final String REMOVED_BRANCH_CLEANUP_PERIOD_CONFIG_KEY
static final String INACTIVE_BRANCH_CLEANUP_CONFIG_KEY
static final String BRANCHES_INACTIVITY_CLEAN_UP_PERIOD
static final String BRANCHES_NOTIFICATION_STRATEGY_CONFIG_KEY
static final String BRANCHES_CUSTOM_CONFIG_KEY
static final String JIRA_BRANCH_LINKING_CONFIG_KEY
static final String BRANCHES_MONITOR_PULL_REQUESTS_CONFIG_KEY
static final String BRANCH_TRIGGERING_CFG_KEY
static final int MINIMUM_INACTIVE_BRANCH_CLEAN_UP_PERIOD
static final int DEFAULT_TIME_OF_INACTIVITY_DAYS
static final int MINIMUM_REMOVED_BRANCH_CLEAN_UP_PERIOD
static final int DEFAULT_REMOVED_BRANCH_CLEAN_UP_PERIOD
static final int REMOVED_BRANCH_DAILY_CLEAN_UP_PERIOD
static final String DEFAULT_BRANCH_MATCH_NAME_PATTERN
@Deprecated boolean isMonitoringEnabled()
isPlanBranchCreationEnabled()
instead to find out if plan branch creation in enabled,
isRemovedBranchCleanUpEnabled()
instead to find out if removed branch cleanup is enabled,
and isInactiveBranchCleanUpEnabled()
()} instead to find out if inactive plan branch cleanup is enabled.@Deprecated void setMonitoringEnabled(boolean enabled)
setPlanBranchCreationEnabled(boolean)
instead to set up automatic plan branch creation,
and setRemovedBranchCleanUpEnabled(boolean)
instead to set up automatic plan branch cleanup.boolean isPlanBranchCreationEnabled()
void setPlanBranchCreationEnabled(boolean enabled)
enabled
- turns on / off this settingboolean isRemovedBranchCleanUpEnabled()
setRemovedBranchCleanUpPeriodInDays(int)
.void setRemovedBranchCleanUpEnabled(boolean enabled)
enabled
- turns on / off this settingboolean isInactiveBranchCleanUpEnabled()
setInactiveBranchCleanUpPeriodInDays(int)
.void setInactiveBranchCleanUpEnabled(boolean enabled)
enabled
- turns on / off this settingString getMatchingPattern()
isPlanBranchCreationEnabled()
.void setMatchingPattern(@NotNull String regularExpression)
setPlanBranchCreationEnabled(boolean)
.regularExpression
- regular expression for the vcs branch name to matchboolean monitorPullRequests()
void setMonitorPullRequests(boolean monitorPullRequests)
@Deprecated boolean isCleanupEnabled()
isRemovedBranchCleanUpEnabled()
instead to find out if branch cleanup is enabled
if the vcs branch is removed, and isInactiveBranchCleanUpEnabled()
instead to find out if cleanup due
to inactivity is enabled.@Deprecated int getTimeOfInactivityInDays()
getInactiveBranchCleanUpPeriodInDays()
to determine the number of days, and
isInactiveBranchCleanUpEnabled()
to determine if it is enabled.@Deprecated void setTimeOfInactivityInDays(int timeOfInactivityInDays)
getInactiveBranchCleanUpPeriodInDays()
to determine the number of days, and
isInactiveBranchCleanUpEnabled()
to determine if it is enabled.int getInactiveBranchCleanUpPeriodInDays()
void setInactiveBranchCleanUpPeriodInDays(int timeOfInactivityInDays)
timeOfInactivityInDays
- number of days a vcs branch is considered to be inactiveint getRemovedBranchCleanUpPeriodInDays()
void setRemovedBranchCleanUpPeriodInDays(int cleanUpPeriodInDays)
cleanUpPeriodInDays
- number of days a plan branch is considered to be removed after@NotNull org.apache.commons.configuration.HierarchicalConfiguration getCustomConfiguration()
void setCustomConfiguration(org.apache.commons.configuration.HierarchicalConfiguration customConfiguration)
BranchNotificationStrategy getDefaultBranchNotificationStrategy()
void setDefaultBranchNotificationStrategy(BranchNotificationStrategy branchNotificationStrategy)
BranchIntegrationConfiguration getDefaultBranchIntegrationConfiguration()
void setDefaultBranchIntegrationConfiguration(BranchIntegrationConfiguration defaultBranchIntegrationConfiguration)
boolean isRemoteJiraBranchLinkingEnabled()
void setRemoteJiraBranchLinkingEnabled(boolean remoteJiraBranchLinkingEnabled)
remoteJiraBranchLinkingEnabled
- enables/disables this setting@NotNull BranchTriggeringOption getBranchTriggeringOption()
void setBranchTriggeringOption(@NotNull BranchTriggeringOption branchTriggeringOption)
Copyright © 2016 Atlassian Software Systems Pty Ltd. All rights reserved.