jetbrains.buildServer.agent.vcs

Interface UpdateByIncludeRules

All Superinterfaces:

AgentExtension, AgentVcsExtension, TeamCityExtension, UpdatePolicy

Deprecated.

use UpdateByIncludeRules2 instead

@Deprecated
 @UserImplemented
public interface UpdateByIncludeRules
extends UpdatePolicy

This is a simplest way to implement agent side checkout. Consider implementing UpdateByCheckoutRules2 instead, if you need to explicitly handle checkout rules.

Since:

4.5

Method Summary

Modifier and Type	Method and Description
IncludeRuleUpdater	getUpdater(VcsRoot root, CheckoutRules checkoutRules, java.lang.String toVersion, java.io.File checkoutDirectory, BuildProgressLogger logger) Deprecated. Factory method that is used to create checkout-by-include rule implementation that will be called for each include rule from CheckoutRules.

Method Detail

getUpdater

IncludeRuleUpdater getUpdater(@NotNull
                              VcsRoot root,
                              @NotNull
                              CheckoutRules checkoutRules,
                              @NotNull
                              java.lang.String toVersion,
                              @NotNull
                              java.io.File checkoutDirectory,
                              @NotNull
                              BuildProgressLogger logger)
                       throws VcsException

Deprecated.

Factory method that is used to create checkout-by-include rule implementation that will be called for each include rule from CheckoutRules. IncludeRuleUpdater.dispose() is called at the end of include rules processing. BuildProgressLogger can be used to add messages in the build log.

Parameters:

root - VCS root

checkoutRules - checkout rules of entire checkout operation

toVersion - version to update sources to

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

logger - build progress logger

Returns:

an instance of IncludeRuleUpdater that will be called for each include rule to perform checkout operation. if any error occurs preventing sources update

Throws:

VcsException - on VCS error

Since:

4.5