com.atlassian.bamboo.vcs.runtime

Interface UpdatingVcsWorkingCopyManager

All Superinterfaces:

VcsWorkingCopyManager

All Known Implementing Classes:

BitbucketCloudWorkingCopyManager, BitbucketServerWorkingCopyManager, GitHubWorkingCopyManager, GitWorkingCopyManager, LegacyFixedDirectoryWorkingCopyManager, LegacyWorkingCopyManager, MercurialWorkingCopyManager

public interface UpdatingVcsWorkingCopyManager
extends VcsWorkingCopyManager

VcsWorkingCopyManager that can update source on vcs server.

Since:

5.14

Method Summary

Modifier and Type	Method and Description
VcsWorkingCopy	commitLocal(VcsWorkingCopy workingCopy, VcsRepositoryData vcsRepositoryData, String commitMessage) Create a local commit.
default void	stageChanges(VcsWorkingCopy workingCopy, VcsRepositoryData repositoryData, Collection<String> pathsToAdd) Stage changes for committing.
VcsWorkingCopy	updateRemote(VcsWorkingCopy workingCopy, VcsRepositoryData vcsRepositoryData, String commitMessage) Update remote repository.

Methods inherited from interface com.atlassian.bamboo.vcs.runtime.VcsWorkingCopyManager

retrieveSourceCode, updateToLatestRevision

Method Detail

stageChanges

default void stageChanges(@NotNull
                          VcsWorkingCopy workingCopy,
                          @NotNull
                          VcsRepositoryData repositoryData,
                          @NotNull
                          Collection<String> pathsToAdd)
                   throws RepositoryException

Stage changes for committing. If staging is not required or supported by repository, this method should do nothing.

Staging logic may differ between repository types. As an example, in Git it is necessary to stage added, modified and removed files before committing. In Mercurial on the other hand, only added and removed files need to be staged (modified files will be committed regardless, as they are considered tracked by the VCS).

Parameters:

workingCopy - workspace to perform the staging

repositoryData - configuration of repository

pathsToAdd - paths, relative to working copy directory, to stage for committing; if empty, all modified files from working copy directory should be staged

Throws:

RepositoryException

commitLocal

@NotNull
VcsWorkingCopy commitLocal(@NotNull
                                    VcsWorkingCopy workingCopy,
                                    @NotNull
                                    VcsRepositoryData vcsRepositoryData,
                                    @NotNull
                                    String commitMessage)
                             throws RepositoryException

Create a local commit. The exact meaning of this operation depends on repository type. In particular, it can be no-op for certain repository types, for example SVN. Intended use: creating a private revision that can be used later in the build.

Parameters:

workingCopy -

vcsRepositoryData -

commitMessage -

Returns:

updated state of local working copy

Throws:

RepositoryException

updateRemote

@NotNull
VcsWorkingCopy updateRemote(@NotNull
                                     VcsWorkingCopy workingCopy,
                                     @NotNull
                                     VcsRepositoryData vcsRepositoryData,
                                     @NotNull
                                     String commitMessage)
                              throws RepositoryException

Update remote repository. The exact meaning of this operation depends on repository type. In DVCS case this should push pre-existing local commit to remote repository. In traditional vcs, like Subversion, this should execute commit operation. Intended use: publishing changes to the world.

Parameters:

workingCopy -

vcsRepositoryData -

commitMessage - - implementors are free to ignore this parameter.

Returns:

updated state of local working copy

Throws:

RepositoryException