jetbrains.buildServer.agent.vcs

Interface UpdateByCheckoutRules2

All Superinterfaces:

AgentExtension, AgentVcsExtension, TeamCityExtension, UpdatePolicy

@UserImplemented
public interface UpdateByCheckoutRules2
extends UpdatePolicy

Implement this interface to support agent side vcs checkout if you want to process CheckoutRules yourself. Consider implementing UpdateByIncludeRules2 interface if you do not need to handle checkout rules processing explicitly.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
void	updateSources(VcsRoot root, CheckoutRules rules, java.lang.String toVersion, java.io.File destFolder, AgentRunningBuild build, boolean cleanCheckoutRequested) Called to update sources in the specified working directory.

Method Detail

updateSources

void updateSources(@NotNull
                   VcsRoot root,
                   @NotNull
                   CheckoutRules rules,
                   @NotNull
                   java.lang.String toVersion,
                   @NotNull
                   java.io.File destFolder,
                   @NotNull
                   AgentRunningBuild build,
                   boolean cleanCheckoutRequested)
            throws VcsException

Called to update sources in the specified working directory. Sources must be updated to the specified version. BuildProgressLogger can be used to add messages in the build log.

Parameters:

build - agent running build. You can get logger by requesting build.getBuildLogger()

cleanCheckoutRequested - true if clean checkout should be performed. Checkout directory itself will be already created by core. The flag also true if some include directory from checkout rules is missing comparing to the previous checkout.

destFolder - working directory where sources will be updated (root directory for the sources)

root - VCS root

toVersion - version to update sources to

rules - checkout rules to consider during sources updating the moment of updateSources call)

Throws:

VcsException - if any error occurs preventing sources update

Since:

6.0