com.atlassian.bamboo.vcs.runtime

Interface VcsWorkingCopyManager

All Known Subinterfaces:

FixedDirectoryWorkingCopyManager, MergingVcsWorkingCopyManager, NoContextVcsWorkingCopyManager, StatusProvidingVcsWorkingCopyManager, UpdatingVcsWorkingCopyManager

All Known Implementing Classes:

BitbucketCloudWorkingCopyManager, BitbucketServerWorkingCopyManager, GitHubWorkingCopyManager, GitWorkingCopyManager, LegacyFixedDirectoryWorkingCopyManager, LegacyWorkingCopyManager, SvnWorkingCopyManager

public interface VcsWorkingCopyManager

Class that can manage working copy in any directory. (i.e. repository represented by a config can checked out to any accessible filesystem location) Implementation should be stateless. Used agent-side.

Since:

5.14

Method Summary

Modifier and Type	Method and Description
@NotNull VcsWorkingCopy	retrieveSourceCode(@NotNull CommonContext commonContext, @NotNull VcsRepositoryData repositoryData, @NotNull PlanVcsRevisionData targetRevision, @NotNull File targetPath) Checkout or update a working copy to a revision.
@NotNull VcsWorkingCopy	updateToLatestRevision(@NotNull CommonContext commonContext, @NotNull VcsRepositoryData repositoryData, @NotNull File targetPath) Checkout or update a working copy to the latest revision.

Method Detail

retrieveSourceCode

@NotNull
@NotNull VcsWorkingCopy retrieveSourceCode(@NotNull
                                                    @NotNull CommonContext commonContext,
                                                    @NotNull
                                                    @NotNull VcsRepositoryData repositoryData,
                                                    @NotNull
                                                    @NotNull PlanVcsRevisionData targetRevision,
                                                    @NotNull
                                                    @NotNull File targetPath)
                                             throws RepositoryException

Checkout or update a working copy to a revision.

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetRevision - - revision to check out or update to

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

RepositoryException

updateToLatestRevision

@NotNull
@NotNull VcsWorkingCopy updateToLatestRevision(@NotNull
                                                        @NotNull CommonContext commonContext,
                                                        @NotNull
                                                        @NotNull VcsRepositoryData repositoryData,
                                                        @NotNull
                                                        @NotNull File targetPath)
                                                 throws RepositoryException

Checkout or update a working copy to the latest revision.

Parameters:

commonContext - - a current build or deployment context

repositoryData - - configuration of a repository to checkout/update

targetPath - - workings copy's path. Note that some legacy implementation may ignore this parameter. (see FixedDirectoryWorkingCopyManager)

Returns:

object representing created/updated working copy

Throws:

RepositoryException