com.atlassian.bitbucket.scm.git.command.merge

Interface GitSquashMergeBuilder

All Superinterfaces:

com.atlassian.bitbucket.scm.CommandBuilderSupport<GitSquashMergeBuilder>, GitCommandBuilderSupport<GitSquashMergeBuilder>, GitMergeBuilderSupport<GitSquashMergeBuilder>

public interface GitSquashMergeBuilder
extends GitMergeBuilderSupport<GitSquashMergeBuilder>

A builder which can be used to construct a command for running git merge --squash. This builder only supports the common merge options.

See Also:

GitMergeBuilder

Field Summary

Fields inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport

ENV_AUTHOR_DATE, ENV_AUTHOR_EMAIL, ENV_AUTHOR_NAME, ENV_COMMITTER_DATE, ENV_COMMITTER_EMAIL, ENV_COMMITTER_NAME

Method Summary

Modifier and Type	Method and Description
GitSquashMergeBuilder	ff(GitMergeFastForward value) Sets the fast-forward mode to use when executing git merge.

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.merge.GitMergeBuilderSupport

build, commit, errorHandler, quiet

Methods inherited from interface com.atlassian.bitbucket.scm.git.command.GitCommandBuilderSupport

alternate, alternates, alternates, author, author, author, build, committer, committer, committer, withConfiguration, withConfiguration, withConfiguration, withConfiguration

Methods inherited from interface com.atlassian.bitbucket.scm.CommandBuilderSupport

clearEnvironment, defaultExitHandler, defaultWorkDir, defaultWorkingDirectory, exitHandler, removeEnvironment, withEnvironment, workDir, workDir, workingDirectory, workingDirectory, workingDirectory

Method Detail

ff

@Nonnull
GitSquashMergeBuilder ff(GitMergeFastForward value)

Sets the fast-forward mode to use when executing git merge. The modes available are documented on the enumeration and have different behaviour when applied to --squash merges:

• --no-ff and --ff are both ignored
  • --ff is accepted by git merge --squash but does not change its behaviour
  • --no-ff causes git merge --squash to fail but mimics the behaviour of a squash merge, which always produces a new commit, and so it is ignored by this builder
• --ff-only when paired with --squash still creates a new commit, but will fail if the source branch is not fast-forward from the target rather than actually performing any merging

Specified by:

ff in interface GitMergeBuilderSupport<GitSquashMergeBuilder>

Parameters:

value - the fast-forward mode to apply when performing the merge; only --ff-only has distinct behaviour

Returns:

this