com.atlassian.jgitflow.core

Class HotfixFinishCommand

java.lang.Object

com.atlassian.jgitflow.core.AbstractGitFlowCommand<ReleaseMergeResult>

com.atlassian.jgitflow.core.HotfixFinishCommand

All Implemented Interfaces:

Callable<ReleaseMergeResult>

public class HotfixFinishCommand
extends AbstractGitFlowCommand<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.AbstractGitFlowCommand

gfConfig, git, reporter

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ReleaseMergeResult	call()
protected String	getCommandName()
HotfixFinishCommand	setAllowUntracked(boolean allow)
HotfixFinishCommand	setFetch(boolean fetch) Set whether to perform a git fetch of the remote branches before doing the merge
HotfixFinishCommand	setKeepBranch(boolean keepBranch) Set whether to keep the local release branch after the merge
HotfixFinishCommand	setMessage(String message) Set the commit message for the tag creation
HotfixFinishCommand	setNoTag(boolean noTag) Set whether to turn off tagging
HotfixFinishCommand	setPush(boolean push) Set whether to push the changes to the remote repository
HotfixFinishCommand	setScmMessagePrefix(String scmMessagePrefix)

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

getScmMessagePrefix, isAllowUntracked, requireCleanWorkingTree, requireCommitOnBranch, requireGitFlowInitialized, requireLocalBranchAbsent, requireLocalBranchExists, requireLocalBranchNotBehindRemote, requireNoExistingHotfixBranches, requireNoExistingReleaseBranches, requireRemoteBranchAbsent, requireRemoteBranchExists, requireTagAbsent

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,
                   JGitFlowReporter reporter)

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

reporter -

Method Detail

setAllowUntracked

public HotfixFinishCommand setAllowUntracked(boolean allow)

Overrides:

setAllowUntracked in class AbstractGitFlowCommand<ReleaseMergeResult>

setScmMessagePrefix

public HotfixFinishCommand setScmMessagePrefix(String scmMessagePrefix)

Overrides:

setScmMessagePrefix in class AbstractGitFlowCommand<ReleaseMergeResult>

call

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

Returns:

nothing

Throws:

JGitFlowGitAPIException

LocalBranchMissingException

DirtyWorkingTreeException

JGitFlowIOException

BranchOutOfDateException

setFetch

public HotfixFinishCommand setFetch(boolean fetch)

Set whether to perform a git fetch of the remote branches before doing the merge

Parameters:

fetch - true to do the fetch, false(default) otherwise

Returns:

this

setMessage

public HotfixFinishCommand setMessage(String message)

Set the commit message for the tag creation

Parameters:

message -

Returns:

this

setPush

public HotfixFinishCommand setPush(boolean push)

Set whether to push the changes to the remote repository

Parameters:

push - true to do the push, false(default) otherwise

Returns:

this

setKeepBranch

public HotfixFinishCommand setKeepBranch(boolean keepBranch)

Set whether to keep the local release branch after the merge

Parameters:

keepBranch - true to keep the branch, false(default) otherwise

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

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<ReleaseMergeResult>