com.atlassian.jgitflow.core

Class ReleaseStartCommand

java.lang.Object

com.atlassian.jgitflow.core.AbstractGitFlowCommand<org.eclipse.jgit.lib.Ref>

com.atlassian.jgitflow.core.ReleaseStartCommand

All Implemented Interfaces:

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

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

gfConfig, git

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

Methods

Modifier and Type	Method and Description
org.eclipse.jgit.lib.Ref	call()
ReleaseStartCommand	setFetch(boolean fetch) Set whether to perform a git fetch of the remote develop branch before branching

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

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

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

Returns:

A reference to the new release branch

Throws:

NotInitializedException

JGitFlowGitAPIException

ReleaseBranchExistsException

DirtyWorkingTreeException

JGitFlowIOException

LocalBranchExistsException

TagExistsException

BranchOutOfDateException

setFetch

public ReleaseStartCommand setFetch(boolean fetch)

Set whether to perform a git fetch of the remote develop branch before branching

Parameters:

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

Returns:

this