public interface GitMergeBuilder extends GitMergeBuilderSupport<GitMergeBuilder>
command
for running
git merge
. In addition to common merge options
, this builder provides
options for controlling the fast-forwardness of the merge, specifying the commit message and including summary
messages in the commit messages to describe the commits which were included in the merge.GitSquashMergeBuilder
ENV_AUTHOR_DATE, ENV_AUTHOR_EMAIL, ENV_AUTHOR_NAME, ENV_COMMITTER_DATE, ENV_COMMITTER_EMAIL, ENV_COMMITTER_NAME
Modifier and Type | Method and Description |
---|---|
GitMergeBuilder |
log(boolean value)
Sets a flag which, when enabled, causes
git merge to include a brief synopsis of the commits included
by the merge. |
GitMergeBuilder |
log(int value)
Sets the number of summary messages to append for commits included in the merge.
|
GitMergeBuilder |
message(String value)
Sets the commit message to be used for the merge.
|
build, commit, errorHandler, ff, quiet
alternate, alternates, alternates, author, author, author, build, committer, committer, committer, withConfiguration, withConfiguration, withConfiguration, withConfiguration
@Nonnull GitMergeBuilder log(boolean value)
git merge
to include a brief synopsis of the commits included
by the merge. The exact output of this flag varies slightly depending on the version of git installed, but in
general it will append summary messages for all commits included by the merged commit which are not already
present on the target branch.
When git merge --log
is enabled using this method, all commits included in the merge will have
their summaries appended. To apply a limit to how many summaries are included, use log(int)
instead.
Note: If a message
is supplied, it will become the first part of the commit message
for the merge and the --log
-produced summaries will be appended after it.
value
- true
to include commit summaries for all merged commits; otherwise, false
(the
default) to use only the provided message
this
@Nonnull GitMergeBuilder log(int value)
0
, no summaries will be appended to the merge's commit message. Otherwise, up to the
number provided will be included. Included commits begin with the commit
specified as
the tip of the merge, traversing from there back through history to older commits until the configured number
have been appended or included commits have been exhausted. The exact output from this setting varies slightly
depending on the version of git installed, but in general it appends summary messages for commits included by
the merged commit which are not already present on the target branch.
Note: If a message
is supplied, it will become the first part of the commit message
for the merge and the --log
-produced summaries will be appended after it.
value
- the number of commits to include summaries for in the merge's commit message; for 0
or
negative values, no summaries will be includedthis
@Nonnull GitMergeBuilder message(String value)
Note: If log(int)
or log(boolean)
is used to enable --log
, any message provided here
is used as the beginning of the commit message and summaries are appended to it.
value
- the commit message for the mergethis
Copyright © 2019 Atlassian. All rights reserved.