com.atlassian.jgitflow.core.command

Class HotfixFinishCommand

java.lang.Object

com.atlassian.jgitflow.core.command.AbstractGitFlowCommand<C,T>

com.atlassian.jgitflow.core.command.AbstractBranchMergingCommand<HotfixFinishCommand,ReleaseMergeResult>

com.atlassian.jgitflow.core.command.HotfixFinishCommand

All Implemented Interfaces:

JGitFlowCommand, Callable<ReleaseMergeResult>

public class HotfixFinishCommand
extends AbstractBranchMergingCommand<HotfixFinishCommand,ReleaseMergeResult>

Finish a hotfix.

This will merge the hotfix into both master and develop and create a tag for the hotfix

Examples (flow is a JGitFlow instance):

Finish a hotfix:

 flow.hotfixFinish("1.0").call();
 

Don't delete the local hotfix branch

 flow.hotfixFinish("1.0").setKeepBranch(true).call();
 

Squash all commits on the hotfix branch into one before merging

 flow.hotfixFinish("1.0").setSquash(true).call();
 

Push changes to the remote origin

 flow.hotfixFinish("1.0").setPush(true).call();
 

Don't create a tag for the hotfix

 flow.hotfixFinish("1.0").setNoTag(true).call();
 

Field Summary

Fields inherited from class com.atlassian.jgitflow.core.command.AbstractGitFlowCommand

gfConfig, git, reporter, requirementHelper

Constructor Summary

Constructors

Constructor and Description
HotfixFinishCommand(String hotfixName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig) Create a new hotfix finish command instance.

Method Summary

Modifier and Type	Method and Description
ReleaseMergeResult	call()
protected String	getCommandName()
HotfixFinishCommand	setExtension(HotfixFinishExtension extension)
HotfixFinishCommand	setMessage(String message) Set the commit message for the tag creation
HotfixFinishCommand	setNoTag(boolean noTag) Set whether to turn off tagging

Methods inherited from class com.atlassian.jgitflow.core.command.AbstractBranchMergingCommand

checkMergeResults, checkoutTopicBranch, cleanupBranchesIfNeeded, createEmptyMergeResult, doMerge, doMerge, doMerge, doTag, getMessage, isAddScmCommentSuffixOnMerge, isForceDeleteBranch, isKeepBranch, setAddScmCommentSuffixOnMerge, setForceDeleteBranch, setKeepBranch

Methods inherited from class com.atlassian.jgitflow.core.command.AbstractGitFlowCommand

doFetchIfNeeded, doPushIfNeeded, enforcer, ensureLocalBranchesNotBehindRemotes, getBranchName, getScmMessagePrefix, getScmMessageSuffix, isAllowUntracked, isFetch, isPush, runBeforeAndGetPrefixedBranchName, runExtensionCommands, setAllowUntracked, setFetch, setPush, setScmMessagePrefix, setScmMessageSuffix

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HotfixFinishCommand

public HotfixFinishCommand(String hotfixName,
                           org.eclipse.jgit.api.Git git,
                           GitFlowConfiguration gfConfig)

Create a new hotfix finish command instance.

An instance of this class is usually obtained by calling JGitFlow.hotfixFinish(String)

Parameters:

hotfixName - The name/version of the hotfix

git - The git instance to use

gfConfig - The GitFlowConfiguration to use

Method Detail

call

public ReleaseMergeResult call()
                        throws JGitFlowGitAPIException,
                               LocalBranchMissingException,
                               DirtyWorkingTreeException,
                               JGitFlowIOException,
                               BranchOutOfDateException,
                               JGitFlowExtensionException,
                               NotInitializedException

Returns:

nothing

Throws:

JGitFlowGitAPIException

LocalBranchMissingException

DirtyWorkingTreeException

JGitFlowIOException

BranchOutOfDateException

JGitFlowExtensionException

NotInitializedException

setMessage

public HotfixFinishCommand setMessage(String message)

Set the commit message for the tag creation

Overrides:

setMessage in class AbstractBranchMergingCommand<HotfixFinishCommand,ReleaseMergeResult>

Parameters:

message -

Returns:

this

setNoTag

public HotfixFinishCommand setNoTag(boolean noTag)

Set whether to turn off tagging

Parameters:

noTag - true to turn off tagging, false(default) otherwise

Returns:

this

setExtension

public HotfixFinishCommand setExtension(HotfixFinishExtension extension)

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<HotfixFinishCommand,ReleaseMergeResult>