jetbrains.buildServer.agent.vcs
Interface CheckoutOnAgentVcsSupport

All Superinterfaces:

AgentExtension, jetbrains.buildServer.TeamCityExtension

public interface CheckoutOnAgentVcsSupport
extends AgentExtension

Implement this interface to provide checkout on agent support for VCS plugin.

Method Summary

java.lang.String	getName() Name of the VCS plugin.
void	updateSources(jetbrains.buildServer.agent.BuildProgressLogger logger, java.io.File workingDirectory, jetbrains.buildServer.vcs.VcsRoot root, java.lang.String newVersion, jetbrains.buildServer.vcs.IncludeRule includeRule) Called to update sources in the specified working directory.

Method Detail

updateSources

void updateSources(@NotNull
                   jetbrains.buildServer.agent.BuildProgressLogger logger,
                   @NotNull
                   java.io.File workingDirectory,
                   @NotNull
                   jetbrains.buildServer.vcs.VcsRoot root,
                   @NotNull
                   java.lang.String newVersion,
                   jetbrains.buildServer.vcs.IncludeRule includeRule)
                   throws jetbrains.buildServer.vcs.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:

logger - build progress logger

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

root - VCS root

newVersion - version to update sources to

includeRule - checkout rule to consider during sources updating

Throws:

jetbrains.buildServer.vcs.VcsException - if any error occurs preventing sources update

getName

@NotNull
java.lang.String getName()

Name of the VCS plugin. Should be the same as VcsSupport.getName()

Returns: