com.atlassian.jgitflow.core

Class ReleaseFinishCommand

java.lang.Object

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

com.atlassian.jgitflow.core.ReleaseFinishCommand

All Implemented Interfaces:

Callable<ReleaseMergeResult>

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

gfConfig, git, reporter

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ReleaseMergeResult	call()
protected String	getCommandName()
ReleaseFinishCommand	setAllowUntracked(boolean allow)
ReleaseFinishCommand	setFetch(boolean fetch) Set whether to perform a git fetch of the remote branches before doing the merge
ReleaseFinishCommand	setKeepBranch(boolean keepBranch) Set whether to keep the local release branch after the merge
ReleaseFinishCommand	setMessage(String message) Set the commit message for the tag creation
ReleaseFinishCommand	setNoMerge(boolean noMerge) Set whether to turn off merging
ReleaseFinishCommand	setNoTag(boolean noTag) Set whether to turn off tagging
ReleaseFinishCommand	setPush(boolean push) Set whether to push the changes to the remote repository
ReleaseFinishCommand	setScmMessagePrefix(String scmMessagePrefix)
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.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

ReleaseFinishCommand

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

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

reporter -

Method Detail

setAllowUntracked

public ReleaseFinishCommand setAllowUntracked(boolean allow)

Overrides:

setAllowUntracked in class AbstractGitFlowCommand<ReleaseMergeResult>

setScmMessagePrefix

public ReleaseFinishCommand 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 ReleaseFinishCommand 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 ReleaseFinishCommand setMessage(String message)

Set the commit message for the tag creation

Parameters:

message -

Returns:

this

setPush

public ReleaseFinishCommand 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 ReleaseFinishCommand 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 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

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<ReleaseMergeResult>