com.atlassian.jgitflow.core.command

Class ReleaseFinishCommand

java.lang.Object

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

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

com.atlassian.jgitflow.core.command.ReleaseFinishCommand

All Implemented Interfaces:

JGitFlowCommand, Callable<ReleaseMergeResult>

public class ReleaseFinishCommand
extends AbstractBranchMergingCommand<ReleaseFinishCommand,ReleaseMergeResult>

Finish a release.

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

Examples (flow is a JGitFlow instance):

Finish a release:

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

Don't delete the local release branch

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

Squash all commits on the release branch into one before merging

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

Push changes to the remote origin

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

Don't create a tag for the release

 flow.releaseFinish("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
ReleaseFinishCommand(String releaseName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig) Create a new release finish command instance.

Method Summary

Modifier and Type	Method and Description
ReleaseMergeResult	call()
protected String	getCommandName()
ReleaseFinishCommand	setExtension(ReleaseFinishExtension extension)
ReleaseFinishCommand	setNoMerge(boolean noMerge) Set whether to turn off merging
ReleaseFinishCommand	setNoTag(boolean noTag) Set whether to turn off tagging
ReleaseFinishCommand	setSquash(boolean squash) Set whether to squash all commits into a single commit before the merge

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, setMessage

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

ReleaseFinishCommand

public ReleaseFinishCommand(String releaseName,
                            org.eclipse.jgit.api.Git git,
                            GitFlowConfiguration gfConfig)

Create a new release finish command instance.

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

Parameters:

releaseName - The name/version of the release

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

setNoTag

public ReleaseFinishCommand setNoTag(boolean noTag)

Set whether to turn off tagging

Parameters:

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

Returns:

this

setSquash

public ReleaseFinishCommand setSquash(boolean squash)

Set whether to squash all commits into a single commit before the merge

Parameters:

squash - true to squash, false(default) otherwise

Returns:

this

setNoMerge

public ReleaseFinishCommand setNoMerge(boolean noMerge)

Set whether to turn off merging

Parameters:

noMerge - true to turn off merging, false(default) otherwise

Returns:

this

setExtension

public ReleaseFinishCommand setExtension(ReleaseFinishExtension extension)

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<ReleaseFinishCommand,ReleaseMergeResult>