com.atlassian.bamboo.repository

Interface PushCapableRepository

All Superinterfaces:

BambooPluginModule, BuildConfigurationAwarePlugin, ConfigurablePlugin, ConvertibleFromConfig, DescriptionProvider, InitablePluginModule, NameProvider, RenderableBuildConfiguration, Repository, RepositoryV2, Serializable

All Known Subinterfaces:

BitbucketDelegatedRepository, StashRepository

All Known Implementing Classes:

BitbucketRepository, GitHubRepository, GitRepository, HgRepository, StashRepositoryImpl

public interface PushCapableRepository
extends Repository

Repository that supports pushing changes back to the remote repository.

Since:

4.0

Field Summary

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

SELECTED_REPOSITORY, UNKNOWN_HOST

Method Summary

Modifier and Type	Method and Description
String	commit(File sourceDirectory, String message) Perform a commit (dvcs commit).
void	pushRevision(File sourceDirectory, String vcsRevisionKey) Push the specified revision to the remote directory.

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

checkConnection, getHost, getKey, getLocationIdentifier, getMinimalEditHtml, getName, getShortKey

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

populateFromConfig, toConfiguration

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

collectChangesSinceLastBuild, getSourceCodeDirectory, isRepositoryDifferent

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

customizeBuildRequirements, removeBuildRequirements

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

addDefaultValues, isConfigurationMissing, prepareConfigObject, validate

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.utils.DescriptionProvider

getDescription

Method Detail

pushRevision

void pushRevision(@NotNull
                  File sourceDirectory,
                  @Nullable
                  String vcsRevisionKey)
           throws RepositoryException

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

Parameters:

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

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

Throws:

RepositoryException - - when something goes wrong

commit

@NotNull
String commit(@NotNull
                       File sourceDirectory,
                       @NotNull
                       String message)
                throws RepositoryException

Perform a commit (dvcs commit).

Parameters:

sourceDirectory - - which workspace directory to perform the commit

message - - what message use for commit

Returns:

Created commit revision key

Throws:

RepositoryException - - when something goes wrong