Package jetbrains.buildServer.vcs

Interface CommitSupport

All Superinterfaces:

VcsExtension

public interface CommitSupport
extends VcsExtension

Support for commit operation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CommitSupport.Config

Method Summary

Modifier and Type	Method	Description
CommitPatchBuilder	getCommitPatchBuilder(VcsRoot root)	Should return a CommitPatchBuilder instance for the given VCS root which is used to make commits.
default CommitPatchBuilder	getCommitPatchBuilder(VcsRoot root, CommitSupport.Config config)	Should return a CommitPatchBuilder instance for the given VCS root which is used to make commits.

Method Detail

getCommitPatchBuilder

@NotNull
CommitPatchBuilder getCommitPatchBuilder(@NotNull
                                         VcsRoot root)
                                  throws VcsException

Should return a CommitPatchBuilder instance for the given VCS root which is used to make commits.

Parameters:

root - VCS root of interest

Returns:

see above

Throws:

VcsException - when it is known upfront that a commit in the given VCS root will fail

getCommitPatchBuilder

@NotNull
default CommitPatchBuilder getCommitPatchBuilder(@NotNull
                                                 VcsRoot root,
                                                 @NotNull
                                                 CommitSupport.Config config)
                                          throws VcsException

Should return a CommitPatchBuilder instance for the given VCS root which is used to make commits. This method allows to configure some general parameters how to commit files using passed config

Parameters:

root - VCS root of interest

Returns:

see above

Throws:

VcsException - when it is known upfront that a commit in the given VCS root will fail