com.atlassian.jgitflow.core.command

Class ReleaseStartCommand

java.lang.Object

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

com.atlassian.jgitflow.core.command.AbstractBranchCreatingCommand<ReleaseStartCommand,org.eclipse.jgit.lib.Ref>

com.atlassian.jgitflow.core.command.ReleaseStartCommand

All Implemented Interfaces:

JGitFlowCommand, Callable<org.eclipse.jgit.lib.Ref>

public class ReleaseStartCommand
extends AbstractBranchCreatingCommand<ReleaseStartCommand,org.eclipse.jgit.lib.Ref>

Start a release.

This will create a new branch using the release prefix and release name from the tip of develop

Examples (flow is a JGitFlow instance):

Start a feature:

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

Perform a fetch of develop before branching

 flow.releaseStart("1.0").setFetch(true).call();
 

Field Summary

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

gfConfig, git, reporter, requirementHelper

Constructor Summary

Constructors

Constructor and Description
ReleaseStartCommand(String releaseName, org.eclipse.jgit.api.Git git, GitFlowConfiguration gfConfig) Create a new release start command instance.

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.lib.Ref	call()
protected String	getCommandName()
ReleaseStartCommand	setExtension(ReleaseStartExtension extension)

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

doCreateBranch, doPushNewBranchIfNeeded, getStartingPoint, setStartCommit, setStartCommit

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

ReleaseStartCommand

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

Create a new release start command instance.

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

Parameters:

releaseName - The name of the release

git - The git instance to use

gfConfig - The GitFlowConfiguration to use

Method Detail

call

public org.eclipse.jgit.lib.Ref call()
                              throws NotInitializedException,
                                     JGitFlowGitAPIException,
                                     ReleaseBranchExistsException,
                                     DirtyWorkingTreeException,
                                     JGitFlowIOException,
                                     LocalBranchExistsException,
                                     TagExistsException,
                                     BranchOutOfDateException,
                                     LocalBranchMissingException,
                                     RemoteBranchExistsException,
                                     JGitFlowExtensionException

Returns:

A reference to the new release branch

Throws:

NotInitializedException

JGitFlowGitAPIException

ReleaseBranchExistsException

DirtyWorkingTreeException

JGitFlowIOException

LocalBranchExistsException

TagExistsException

BranchOutOfDateException

LocalBranchMissingException

RemoteBranchExistsException

JGitFlowExtensionException

getCommandName

protected String getCommandName()

Specified by:

getCommandName in class AbstractGitFlowCommand<ReleaseStartCommand,org.eclipse.jgit.lib.Ref>

setExtension

public ReleaseStartCommand setExtension(ReleaseStartExtension extension)