Package com.atlassian.bamboo.plugins.git

Class GitHubRepository

java.lang.Object

com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

com.atlassian.bamboo.v2.build.BaseConfigurablePlugin

com.atlassian.bamboo.repository.AbstractRepository

com.atlassian.bamboo.repository.AbstractStandaloneRepository

com.atlassian.bamboo.plugins.git.GitHubRepository

All Implemented Interfaces:

ConvertibleFromConfig, InitablePluginModule, GitRepositoryFacade, AdvancedConfigurationAwareRepository, BranchAwareRepository, BranchDetectionCapableRepository, BranchInformationProvider, BranchMergingAwareRepository, CachingAwareRepository, CustomVariableProviderRepository, DeploymentAwareRepository, FilterChangesetAwareRepository, IncludeExcludeAwareRepository, OnceOffCapableRepository, PushCapableRepository, QuietPeriodAwareRepository, Repository, StandaloneRepository, UniqueRevisionIdRepository, DescriptionProvider, NameProvider, BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, RenderableBuildConfiguration, CustomSourceDirectoryAwareRepository, RepositoryV2, Serializable

public class GitHubRepository
extends AbstractStandaloneRepository
implements AdvancedConfigurationAwareRepository, BranchInformationProvider, BranchMergingAwareRepository, CachingAwareRepository, CustomSourceDirectoryAwareRepository, CustomVariableProviderRepository, DeploymentAwareRepository, GitRepositoryFacade, PushCapableRepository, UniqueRevisionIdRepository

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.repository.CachingAwareRepository

CachingAwareRepository.CachableOperation

Field Summary

Fields inherited from class com.atlassian.bamboo.repository.AbstractRepository

administrationConfigurationAccessor, BUILD_TRIGGER_IP, buildDirectoryManager, buildLoggerManager, customVariableContext, featureManager, REPO_PREFIX, repositoryModuleDescriptor, templateRenderer, textProvider

Fields inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

moduleDescriptor

Fields inherited from interface com.atlassian.bamboo.repository.FilterChangesetAwareRepository

CHANGESET_FILTER_PATTERN_REGEX, MAVEN_RELEASE_PLUGIN_EXCLUSION_PATTERN

Fields inherited from interface com.atlassian.bamboo.plugins.git.GitRepositoryFacade

GIT_REPOSITORIES_OF_PLAN

Fields inherited from interface com.atlassian.bamboo.repository.IncludeExcludeAwareRepository

FILTER_PATTERN_EXCLUDE, FILTER_PATTERN_INCLUDE, FILTER_PATTERN_NONE, FILTER_PATTERN_OPTION, FILTER_PATTERN_REGEX

Fields inherited from interface com.atlassian.bamboo.repository.Repository

SELECTED_REPOSITORY, UNKNOWN_HOST

Constructor Summary

Constructors

Constructor	Description
GitHubRepository()

Method Summary

Modifier and Type	Method	Description
void	addDefaultValues(@NotNull BuildConfiguration buildConfiguration)	Extension point for adding default values to the form for RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)
@NotNull BuildRepositoryChanges	collectChangesForRevision(@NotNull PlanKey planKey, @NotNull String targetRevision)	Collects the changes for the targetRevision.
@NotNull BuildRepositoryChanges	collectChangesSinceLastBuild(@NotNull String planKey, @Nullable String lastVcsRevisionKey)	Collects the changes since the lastVcsRevisionKey.
@NotNull String	commit(@NotNull File file, @NotNull String s)	Perform a commit (dvcs commit).
GitHubRepositoryAccessData	getAccessData()
String	getBaseUrl()
String	getBranch()
CacheId	getCacheId(@NotNull CachingAwareRepository.CachableOperation cachableOperation)	Cache id has to fulfill the following: Given two Repository objects A and B, returning equal CacheId (in terms of equals()) and a cachable operation foo(), in the following sequence of calls made in a short time period: 1.
int	getCommandTimeout()
@NotNull Map<String,String>	getCustomVariables()	Return a map containing name->value mapping of the variables.
CommitContext	getFirstCommit()	Retrieve the commit that created the Branch.
GitRepository	getGitRepository()
String	getHost()	What's the repository server host
CommitContext	getLastCommit()	Retrieve last commit on the branch set on this Repository.
@NotNull String	getName()	The display name for the repository type
@NotNull List<VcsBranch>	getOpenBranches(@Nullable String context)	Set of open branches that are discovered in the repository.
String	getOptionDescription()
String	getPassword()
@NotNull Map<String,String>	getPlanRepositoryVariables()	Return a map containing name->value mapping of the plan repository format variables.
String	getRepository()
String	getUsername()
@NotNull VcsBranch	getVcsBranch()
boolean	getVerboseLogs()
boolean	isCachingSupportedFor(@NotNull CachingAwareRepository.CachableOperation cachableOperation)
boolean	isMergingSupported()
boolean	isRepositoryDifferent(@NotNull Repository repository)	Checks if the current repo is the same as the given repository
boolean	isUseRemoteAgentCache()
boolean	isUseShallowClones()
boolean	isUseSubmodules()
boolean	isWebhooksEnabled()
boolean	mergeWorkspaceWith(@NotNull BuildContext buildContext, @NotNull File file, @NotNull String s)	Merges a workspace located in checkout directory with the target revision.
void	populateFromConfig(@NotNull org.apache.commons.configuration.HierarchicalConfiguration config)	Update the current object with data in the HierarchicalConfiguration
void	postConstruct()
void	prepareConfigObject(@NotNull BuildConfiguration buildConfiguration)	Do any preprocessing work before validation occurs.
void	pushRevision(@NotNull File file, @Nullable String s)	Push the specified revision to the remote directory.
@NotNull String	retrieveSourceCode(@NotNull BuildContext buildContext, @Nullable String vcsRevision)
@NotNull String	retrieveSourceCode(@NotNull BuildContext buildContext, @Nullable String vcsRevisionKey, @NotNull File sourceDirectory)	Checks out the latest source code from an appropriate repository to specified directory
@NotNull String	retrieveSourceCode(@NotNull BuildContext buildContext, @Nullable String vcsRevisionKey, @NotNull File sourceDirectory, int depth)	Checks out the latest source code from an appropriate repository to specified directory
void	setAccessData(GitHubRepositoryAccessData gitHubAccessData)
void	setBranchIntegrationHelper(VcsBranchIntegrationHelper branchIntegrationHelper)
void	setBuildDirectoryManager(BuildDirectoryManager buildDirectoryManager)
void	setBuildLoggerManager(BuildLoggerManager buildLoggerManager)
void	setCapabilityContext(CapabilityContext capabilityContext)
void	setCustomVariableContext(CustomVariableContext customVariableContext)
void	setI18nResolver(com.atlassian.sal.api.message.I18nResolver i18nResolver)
void	setOutboundWhitelist(com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)
void	setSshProxyService(SshProxyService sshProxyService)
void	setTrustedKeyHelper(TrustedKeyHelper trustedKeyHelper)
void	setVcsBranch(@NotNull VcsBranch vcsBranch)	Set and prepare the repository for using an arbitrary branch.
@NotNull org.apache.commons.configuration.HierarchicalConfiguration	toConfiguration()	Generate a HierarchicalConfiguration from the current state of the object
boolean	usePollingForBranchDetection()	If Bamboo generic detection polling should be used for this repository
@NotNull ErrorCollection	validate(@NotNull BuildConfiguration buildConfiguration)	Validates the properties in the BuildConfiguration object.

Methods inherited from class com.atlassian.bamboo.repository.AbstractStandaloneRepository

getAdvancedEditHtml, getAdvancedViewHtml, getEditHtml, getViewHtml, getViewHtml

Methods inherited from class com.atlassian.bamboo.repository.AbstractRepository

customizeBuildRequirements, getAdvancedEditHtml, getAdvancedViewHtml, getBranchIntegrationEditHtml, getChangesetFilterPatternRegex, getDefaultTriggerModule, getDescription, getEditHtml, getFilterFilePatternOption, getFilterFilePatternRegex, getKey, getLocationIdentifier, getMavenPomCheckoutAccessEditHtml, getMaxCommitsToReturn, getMaxRetries, getMinimalEditHtml, getPollingTriggerModule, getQuietPeriod, getShortKey, getSourceCodeDirectory, getSystemWideExclusionPatterns, getViewHtml, getWorkingDirectory, init, isAdvancedOptionEnabled, isQuietPeriodEnabled, isWorkspaceEmpty, removeBuildRequirements, setAdministrationConfigurationAccessor, setChangesetFilterPatternRegex, setFeatureManager, setFilterFilePatternOption, setFilterFilePatternRegex, setTemplateRenderer, setTextProvider, setWorkingDir, substituteString, toMergeCapableRepository

Methods inherited from class com.atlassian.bamboo.v2.build.BaseBuildConfigurationAwarePlugin

getTemplateRenderer, populateContextForEdit, populateContextForView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.repository.AdvancedConfigurationAwareRepository

getAdvancedEditHtml, getAdvancedViewHtml

Methods inherited from interface com.atlassian.bamboo.repository.BranchMergingAwareRepository

getBranchIntegrationEditHtml

Methods inherited from interface com.atlassian.bamboo.v2.build.BuildConfigurationAwarePlugin

isConfigurationMissing

Methods inherited from interface com.atlassian.bamboo.v2.build.ConfigurablePlugin

customizeBuildRequirements, removeBuildRequirements

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

Methods inherited from interface com.atlassian.bamboo.plugin.InitablePluginModule

init

Methods inherited from interface com.atlassian.bamboo.v2.build.RenderableBuildConfiguration

getEditHtml, getViewHtml

Methods inherited from interface com.atlassian.bamboo.repository.Repository

getKey, getLocationIdentifier, getMinimalEditHtml, getShortKey

Methods inherited from interface com.atlassian.bamboo.v2.build.repository.RepositoryV2

getSourceCodeDirectory

Constructor Details

GitHubRepository

public GitHubRepository()

Method Details

setBuildDirectoryManager

public void setBuildDirectoryManager(BuildDirectoryManager buildDirectoryManager)

Overrides:

setBuildDirectoryManager in class AbstractRepository

setBuildLoggerManager

public void setBuildLoggerManager(BuildLoggerManager buildLoggerManager)

Overrides:

setBuildLoggerManager in class AbstractRepository

setI18nResolver

public void setI18nResolver(com.atlassian.sal.api.message.I18nResolver i18nResolver)

setTrustedKeyHelper

public void setTrustedKeyHelper(TrustedKeyHelper trustedKeyHelper)

setOutboundWhitelist

public void setOutboundWhitelist(com.atlassian.plugins.whitelist.OutboundWhitelist outboundWhitelist)

setCustomVariableContext

public void setCustomVariableContext(CustomVariableContext customVariableContext)

Overrides:

setCustomVariableContext in class AbstractRepository

setCapabilityContext

public void setCapabilityContext(CapabilityContext capabilityContext)

setSshProxyService

public void setSshProxyService(SshProxyService sshProxyService)

setBranchIntegrationHelper

public void setBranchIntegrationHelper(VcsBranchIntegrationHelper branchIntegrationHelper)

postConstruct

@PostConstruct
public void postConstruct()

getName

@NotNull
public @NotNull String getName()

Description copied from interface: Repository

The display name for the repository type

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Specified by:

getName in interface Repository

getHost

public String getHost()

Description copied from interface: Repository

What's the repository server host

Specified by:

getHost in interface Repository

Returns:

The host!

isRepositoryDifferent

public boolean isRepositoryDifferent(@NotNull
 @NotNull Repository repository)

Description copied from interface: RepositoryV2

Checks if the current repo is the same as the given repository

Specified by:

isRepositoryDifferent in interface RepositoryV2

Parameters:

repository - to compare against

Returns:

true of repositories are different, false if the same;

addDefaultValues

public void addDefaultValues(@NotNull
 @NotNull BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Extension point for adding default values to the form for RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan)

Specified by:

addDefaultValues in interface BuildConfigurationAwarePlugin

Overrides:

addDefaultValues in class AbstractRepository

Parameters:

buildConfiguration - -

prepareConfigObject

public void prepareConfigObject(@NotNull
 @NotNull BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Do any preprocessing work before validation occurs. For repository, builder and web repository plugins this will only be called if the plugin is select by the user.

Specified by:

prepareConfigObject in interface BuildConfigurationAwarePlugin

Overrides:

prepareConfigObject in class BaseBuildConfigurationAwarePlugin

Parameters:

buildConfiguration - -

populateFromConfig

public void populateFromConfig(@NotNull
 @NotNull org.apache.commons.configuration.HierarchicalConfiguration config)

Description copied from interface: ConvertibleFromConfig

Update the current object with data in the HierarchicalConfiguration

Specified by:

populateFromConfig in interface ConvertibleFromConfig

Overrides:

populateFromConfig in class AbstractRepository

toConfiguration

@NotNull
public @NotNull org.apache.commons.configuration.HierarchicalConfiguration toConfiguration()

Description copied from interface: ConvertibleFromConfig

Generate a HierarchicalConfiguration from the current state of the object

Specified by:

toConfiguration in interface ConvertibleFromConfig

Overrides:

toConfiguration in class AbstractRepository

Returns:

Always returns an HierarchicalConfiguration. Never null

validate

@NotNull
public @NotNull ErrorCollection validate(@NotNull
 @NotNull BuildConfiguration buildConfiguration)

Description copied from interface: BuildConfigurationAwarePlugin

Validates the properties in the BuildConfiguration object. The name of the properties match those passed in through the form fragments in RenderableBuildConfiguration.getEditHtml(com.atlassian.bamboo.ww2.actions.build.admin.create.BuildConfiguration, com.atlassian.bamboo.plan.Plan) template.

Specified by:

validate in interface BuildConfigurationAwarePlugin

Overrides:

validate in class AbstractRepository

Parameters:

buildConfiguration - -

Returns:

ErrorCollection keyed by the field name.

collectChangesForRevision

@NotNull
public @NotNull BuildRepositoryChanges collectChangesForRevision(@NotNull
 @NotNull PlanKey planKey,
 @NotNull
 @NotNull String targetRevision)
                                                          throws RepositoryException

Description copied from interface: OnceOffCapableRepository

Collects the changes for the targetRevision. This method is called only on server side (never on agent).

Specified by:

collectChangesForRevision in interface OnceOffCapableRepository

Overrides:

collectChangesForRevision in class AbstractRepository

Returns:

A build changes object with the appropriate build changes (that is - with the single commit data relevant for targetRevision)

Throws:

RepositoryException - if something goes wrong

collectChangesSinceLastBuild

@NotNull
public @NotNull BuildRepositoryChanges collectChangesSinceLastBuild(@NotNull
 @NotNull String planKey,
 @Nullable
 @Nullable String lastVcsRevisionKey)
                                                             throws RepositoryException

Description copied from interface: RepositoryV2

Collects the changes since the lastVcsRevisionKey. This method is called only on server side (never on agent).

Specified by:

collectChangesSinceLastBuild in interface RepositoryV2

lastVcsRevisionKey - can be null, if null you should ensure the correct vcsrevisionkey is returned in the BuildChanges object.

Returns:

A build changes object with the appropriate build changes

Throws:

RepositoryException - if something goes wrong

retrieveSourceCode

@NotNull
public @NotNull String retrieveSourceCode(@NotNull
 @NotNull BuildContext buildContext,
 @Nullable
 @Nullable String vcsRevision)
                                   throws RepositoryException

Throws:

RepositoryException

retrieveSourceCode

@NotNull
public @NotNull String retrieveSourceCode(@NotNull
 @NotNull BuildContext buildContext,
 @Nullable
 @Nullable String vcsRevisionKey,
 @NotNull
 @NotNull File sourceDirectory)
                                   throws RepositoryException

Description copied from interface: CustomSourceDirectoryAwareRepository

Checks out the latest source code from an appropriate repository to specified directory

Specified by:

retrieveSourceCode in interface CustomSourceDirectoryAwareRepository

vcsRevisionKey - - may be null if you want latest code

sourceDirectory - - directory to checkout to

Returns:

vcsRevisionKey - the revision

Throws:

RepositoryException

retrieveSourceCode

@NotNull
public @NotNull String retrieveSourceCode(@NotNull
 @NotNull BuildContext buildContext,
 @Nullable
 @Nullable String vcsRevisionKey,
 @NotNull
 @NotNull File sourceDirectory,
 int depth)
                                   throws RepositoryException

Description copied from interface: BranchMergingAwareRepository

Checks out the latest source code from an appropriate repository to specified directory

Specified by:

retrieveSourceCode in interface BranchMergingAwareRepository

vcsRevisionKey - - may be null if you want latest code

sourceDirectory - - directory to checkout to

depth - - how many historical revisions we'd like to check out (-1 means all revisions)

Returns:

vcsRevisionKey - the revision

Throws:

RepositoryException

getUsername

public String getUsername()

getRepository

public String getRepository()

getBranch

public String getBranch()

isUseShallowClones

public boolean isUseShallowClones()

isUseRemoteAgentCache

public boolean isUseRemoteAgentCache()

getPassword

public String getPassword()

isUseSubmodules

public boolean isUseSubmodules()

getCommandTimeout

public int getCommandTimeout()

getVerboseLogs

public boolean getVerboseLogs()

isWebhooksEnabled

public boolean isWebhooksEnabled()

getBaseUrl

public String getBaseUrl()

getOpenBranches

@NotNull
public @NotNull List<VcsBranch> getOpenBranches(@Nullable
 @Nullable String context)
                                         throws RepositoryException

Description copied from interface: BranchDetectionCapableRepository

Set of open branches that are discovered in the repository. Returns empty collection if no branches at all (can that happen?). Used for monitoring repositories for new branches. An open branch is a branch that is considered 'open' by underlying VCS - it has nothing to do with the actual development on that branch (recent commits or so).

Specified by:

getOpenBranches in interface BranchDetectionCapableRepository

Returns:

List of branch names. May be empty.

Throws:

RepositoryException

getVcsBranch

@NotNull
public @NotNull VcsBranch getVcsBranch()

Specified by:

getVcsBranch in interface BranchAwareRepository

Returns:

the branch being used currently by this repository.

setVcsBranch

public void setVcsBranch(@NotNull
 @NotNull VcsBranch vcsBranch)

Description copied from interface: BranchAwareRepository

Set and prepare the repository for using an arbitrary branch. Generally the subsequent getVcsBranch should return the same branch name.

Specified by:

setVcsBranch in interface BranchAwareRepository

getCacheId

public CacheId getCacheId(@NotNull
 @NotNull CachingAwareRepository.CachableOperation cachableOperation)

Description copied from interface: CachingAwareRepository

Cache id has to fulfill the following: Given two Repository objects A and B, returning equal CacheId (in terms of equals()) and a cachable operation foo(), in the following sequence of calls made in a short time period: 1. A::foo() 2. B::foo() 3. A::foo() the result of B::foo() should be the same as either the first or the second call to A::foo().

Specified by:

getCacheId in interface CachingAwareRepository

Returns:

the cache id of repository, null if the supplied operation cannot be cached

isCachingSupportedFor

public boolean isCachingSupportedFor(@NotNull
 @NotNull CachingAwareRepository.CachableOperation cachableOperation)

Specified by:

isCachingSupportedFor in interface CachingAwareRepository

Returns:

true if the repository supports generation of CacheIds for a given operation

getLastCommit

public CommitContext getLastCommit()
                            throws RepositoryException

Description copied from interface: BranchDetectionCapableRepository

Retrieve last commit on the branch set on this Repository. Method is used by Chain Branch automatic expiry. If this method returns null Chain Branch is not expired.

Specified by:

getLastCommit in interface BranchDetectionCapableRepository

Returns:

the last commit or null if N/A

Throws:

RepositoryException

getFirstCommit

public CommitContext getFirstCommit()
                             throws RepositoryException

Description copied from interface: BranchDetectionCapableRepository

Retrieve the commit that created the Branch.

Specified by:

getFirstCommit in interface BranchDetectionCapableRepository

Returns:

the first commit to the branch

Throws:

RepositoryException

mergeWorkspaceWith

public boolean mergeWorkspaceWith(@NotNull
 @NotNull BuildContext buildContext,
 @NotNull
 @NotNull File file,
 @NotNull
 @NotNull String s)
                           throws RepositoryException

Description copied from interface: BranchMergingAwareRepository

Merges a workspace located in checkout directory with the target revision.

Specified by:

mergeWorkspaceWith in interface BranchMergingAwareRepository

Parameters:

buildContext - the build context of build doing the merge

file - the workspace to use for merge

s - the revision to merge with

Returns:

true if the result of the merge would result in a non-empty commit

Throws:

RepositoryException

isMergingSupported

public boolean isMergingSupported()

Specified by:

isMergingSupported in interface BranchMergingAwareRepository

pushRevision

public void pushRevision(@NotNull
 @NotNull File file,
 @Nullable
 @Nullable String s)
                  throws RepositoryException

Description copied from interface: PushCapableRepository

Push the specified revision to the remote directory. Throws RepositoryException when failed due to connection problems or similar.

Specified by:

pushRevision in interface PushCapableRepository

Parameters:

file - - the working directory of the repository we want to push from

s - - the revisionKey (usually a branch name) to push

Throws:

RepositoryException - - when something goes wrong

commit

@NotNull
public @NotNull String commit(@NotNull
 @NotNull File file,
 @NotNull
 @NotNull String s)
                       throws RepositoryException

Description copied from interface: PushCapableRepository

Perform a commit (dvcs commit).

Specified by:

commit in interface PushCapableRepository

Parameters:

file - - which workspace directory to perform the commit

s - - what message use for commit

Returns:

Created commit revision key

Throws:

RepositoryException - - when something goes wrong

getOptionDescription

public String getOptionDescription()

getAccessData

public GitHubRepositoryAccessData getAccessData()

setAccessData

public void setAccessData(GitHubRepositoryAccessData gitHubAccessData)

getGitRepository

public GitRepository getGitRepository()

Specified by:

getGitRepository in interface GitRepositoryFacade

usePollingForBranchDetection

public boolean usePollingForBranchDetection()

Description copied from interface: BranchInformationProvider

If Bamboo generic detection polling should be used for this repository

Specified by:

usePollingForBranchDetection in interface BranchInformationProvider

Returns:

getCustomVariables

@NotNull
public @NotNull Map<String,String> getCustomVariables()

Description copied from interface: CustomVariableProviderRepository

Return a map containing name->value mapping of the variables.

Null values will be filtered out so it's safe to put them in the map.

Specified by:

getCustomVariables in interface CustomVariableProviderRepository

Returns:

Map with variable substitutions

getPlanRepositoryVariables

@NotNull
public @NotNull Map<String,String> getPlanRepositoryVariables()

Description copied from interface: CustomVariableProviderRepository

Return a map containing name->value mapping of the plan repository format variables.

Null values will be filtered out so it's safe to put them in the map.

Specified by:

getPlanRepositoryVariables in interface CustomVariableProviderRepository

Returns:

Map with variable substitutions