com.atlassian.bamboo.plugins.git

Interface GitOperationHelper

All Known Implementing Classes:

AbstractGitOperationHelper, JGitOperationHelper, NativeGitOperationHelper

public interface GitOperationHelper

Method Summary

Modifier and Type	Method and Description
String	checkout(File cacheDirectory, File sourceDirectory, String targetRevision, String previousRevision)
boolean	checkRevisionExistsInCacheRepository(File repositoryDirectory, String targetRevision)
default String	commit(File sourceDirectory, String message, String committerName, String committerEmail)
String	commit(File sourceDirectory, String message, String committerName, String committerEmail, boolean stageModifications)
void	createBranch(File sourceDirectory, String branchName)
void	createLightweightTag(File sourceDirectory, String tagName, String revision)
BuildRepositoryChanges	extractCommits(File cacheDirectory, String startingRevision, String endingRevision)
BuildRepositoryChanges	extractCommits(File cacheDirectory, String startingRevision, String endingRevision, String path)
BuildRepositoryChanges	extractCommitsBetweenBranches(File cacheDirectory, VcsBranch otherBranch, boolean limitChangeList)
void	fetch(File sourceDirectory, HashAndSource refAndHash, boolean useShallow)
void	fetch(File sourceDirectory, String targetRevision, boolean useShallow)
Optional<String>	getBranchForSha(File sourceDirectory, String revision, String configuredBranch)
CommitContext	getCommit(File directory, String targetRevision) Gets the commit for the revision, given a working directory.
String	getCurrentBranch(File checkoutPath)
String	getCurrentRevision(File sourceDirectory)
List<VcsBranch>	getOpenBranches(GitRepositoryAccessData repositoryData, File workingDir)
String	getShaOfRefIfExists(File sourceDirectory, String ref)
boolean	isAncestor(Path gitWorkspace, GitHash rev1, GitHash rev2) Returns true if you can reach rev1 by following parent relationship starting from rev2.
boolean	isClean(File sourceDirectory)
boolean	merge(File workspaceDir, String targetRevision, String committerName, String committerEmail)
Pair<Boolean,String>	mergeAndReturnHead(File workspaceDir, String currentRevision, String targetRevision, String committerName, String committerEmail)
HashAndSource	obtainLatestRevision()
Optional<GitHash>	obtainLatestRevision(File repositoryDirectory, GitRef ref, String path)
void	pushBranchOrTag(File sourceDirectory, String refName)
void	pushRevision(File sourceDirectory, String revision, String currentBranch)
void	stageChanges(File sourceDirectory, Collection<String> pathsToAdd)

Method Detail

pushRevision

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

Throws:

RepositoryException

pushBranchOrTag

void pushBranchOrTag(@NotNull
                     File sourceDirectory,
                     @NotNull
                     String refName)
              throws RepositoryException

Throws:

RepositoryException

commit

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

Throws:

RepositoryException

commit

@NotNull
String commit(@NotNull
                       File sourceDirectory,
                       @NotNull
                       String message,
                       @NotNull
                       String committerName,
                       @NotNull
                       String committerEmail,
                       boolean stageModifications)
                throws RepositoryException

Throws:

RepositoryException

stageChanges

void stageChanges(@NotNull
                  File sourceDirectory,
                  @NotNull
                  Collection<String> pathsToAdd)
           throws RepositoryException

Throws:

RepositoryException

checkout

@NotNull
String checkout(@Nullable
                         File cacheDirectory,
                         @NotNull
                         File sourceDirectory,
                         @NotNull
                         String targetRevision,
                         @Nullable
                         String previousRevision)
                  throws RepositoryException

Throws:

RepositoryException

fetch

void fetch(@NotNull
           File sourceDirectory,
           @NotNull
           String targetRevision,
           boolean useShallow)
    throws RepositoryException

Throws:

RepositoryException

fetch

void fetch(@NotNull
           File sourceDirectory,
           @NotNull
           HashAndSource refAndHash,
           boolean useShallow)
    throws RepositoryException

Throws:

RepositoryException

getCurrentRevision

@NotNull
String getCurrentRevision(@NotNull
                                   File sourceDirectory)
                            throws RepositoryException

Throws:

RepositoryException

isClean

boolean isClean(@NotNull
                File sourceDirectory)
         throws RepositoryException

Throws:

RepositoryException

getShaOfRefIfExists

@Nullable
String getShaOfRefIfExists(@NotNull
                                     File sourceDirectory,
                                     @NotNull
                                     String ref)

obtainLatestRevision

@NotNull
HashAndSource obtainLatestRevision()
                                     throws RepositoryException

Throws:

RepositoryException

getOpenBranches

@NotNull
List<VcsBranch> getOpenBranches(@NotNull
                                         GitRepositoryAccessData repositoryData,
                                         File workingDir)
                                  throws RepositoryException

Throws:

RepositoryException

checkRevisionExistsInCacheRepository

boolean checkRevisionExistsInCacheRepository(@NotNull
                                             File repositoryDirectory,
                                             @NotNull
                                             String targetRevision)
                                      throws IOException,
                                             RepositoryException

Throws:

IOException

RepositoryException

getCommit

@NotNull
CommitContext getCommit(File directory,
                                 String targetRevision)
                          throws RepositoryException

Gets the commit for the revision, given a working directory.

Throws:

RepositoryException - if the revision can't be found

merge

boolean merge(@NotNull
              File workspaceDir,
              @NotNull
              String targetRevision,
              @NotNull
              String committerName,
              @NotNull
              String committerEmail)
       throws RepositoryException

Throws:

RepositoryException

mergeAndReturnHead

Pair<Boolean,String> mergeAndReturnHead(@NotNull
                                        File workspaceDir,
                                        @NotNull
                                        String currentRevision,
                                        @NotNull
                                        String targetRevision,
                                        @NotNull
                                        String committerName,
                                        @NotNull
                                        String committerEmail)
                                 throws RepositoryException

Throws:

RepositoryException

extractCommits

BuildRepositoryChanges extractCommits(File cacheDirectory,
                                      @NotNull
                                      String startingRevision,
                                      String endingRevision)
                               throws RepositoryException

Throws:

RepositoryException

getBranchForSha

@NotNull
Optional<String> getBranchForSha(@NotNull
                                          File sourceDirectory,
                                          String revision,
                                          String configuredBranch)
                                   throws RepositoryException

Returns:

branch that contains sha and matches the name of configuredBranch

Throws:

RepositoryException

obtainLatestRevision

Optional<GitHash> obtainLatestRevision(@NotNull
                                       File repositoryDirectory,
                                       GitRef ref,
                                       String path)
                                throws RepositoryException

Throws:

RepositoryException

isAncestor

boolean isAncestor(@NotNull
                   Path gitWorkspace,
                   @NotNull
                   GitHash rev1,
                   @NotNull
                   GitHash rev2)
            throws RepositoryException

Returns true if you can reach rev1 by following parent relationship starting from rev2.

Throws:

RepositoryException

extractCommits

BuildRepositoryChanges extractCommits(File cacheDirectory,
                                      @NotNull
                                      String startingRevision,
                                      String endingRevision,
                                      String path)
                               throws RepositoryException

Throws:

RepositoryException

extractCommitsBetweenBranches

BuildRepositoryChanges extractCommitsBetweenBranches(File cacheDirectory,
                                                     VcsBranch otherBranch,
                                                     boolean limitChangeList)
                                              throws RepositoryException

Throws:

RepositoryException

createBranch

void createBranch(@NotNull
                  File sourceDirectory,
                  @NotNull
                  String branchName)
           throws RepositoryException

Throws:

RepositoryException

createLightweightTag

void createLightweightTag(@NotNull
                          File sourceDirectory,
                          @NotNull
                          String tagName,
                          @NotNull
                          String revision)
                   throws RepositoryException

Throws:

RepositoryException

getCurrentBranch

String getCurrentBranch(File checkoutPath)
                 throws RepositoryException

Throws:

RepositoryException