Maven JGit-Flow Plugin

Feature Start

Full name: com.atlassian.maven.plugins:maven-jgitflow-plugin:1.0-m4:feature-start

Short name: jgitflow:feature-start

Description: Prepares the project for a new feature. Creates a feature branch and updates poms with the feature version.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator plugin.

Configuration

Name	Type	Description
allowSnapshots	boolean	Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT. Default value is: false User property is: allowSnapshots
allowUntracked	boolean	Whether to allow untracked files when checking if the working tree is clean. Default value is: false. User property is: allowUntracked.
defaultOriginUrl	String	Default url to use if origin remote is not found in .git/config. User property is: defaultOriginUrl.
enableFeatureVersions	boolean	Whether to append the feature name to the version on the feature branch. Default value is: false User property is: enableFeatureVersions
enableSshAgent	boolean	Whether to enable using an ssh-agent. Default value is: false. User property is: enableSshAgent.
featureName	String	The name of the new feature branch. User property is: featureName.
flowInitContext	FlowInitContext	Used to override default git-flow branch names and prefixes
pushFeatures	boolean	Whether to push feature branches to the remote upstream. Default value is: false. User property is: pushFeatures.
scmCommentPrefix	String	The message prefix to use for all SCM changes. Default value is: "" User property is: scmCommentPrefix.
startCommit	String	A SHA, short SHA, or branch name to use as the starting point for the new branch User property is: startCommit.

Parameter Details

allowUntracked

Whether to allow untracked files when checking if the working tree is clean.

Type: boolean
Required: no
User Property: allowUntracked
Default: false

enableFeatureVersions

Whether to append the feature name to the version on the feature branch.

Type: boolean
Required: no
User Property: enableFeatureVersions
Default: false

defaultOriginUrl

Default url to use if origin remote is not found in .git/config.

This can be any acceptable git url that you would normally put in .git/config

Type: java.lang.String
Required: no
User Property: defaultOriginUrl

enableSshAgent

Whether to enable using an ssh-agent

Type: boolean
Required: no
User Property: enableSshAgent
Default: false

featureName

Name for the new feature branch

Type: java.lang.String
Required: no
User Property: featureName

flowInitContext

Type: com.atlassian.maven.plugins.jgitflow.FlowInitContext
Required: no
Default: ${flowInitContext}

Object Properties

Name	Type	Description
masterBranchName	String	The name of the master branch. Default value is: master
developBranchName	String	The name of the development branch. Default value is: develop
featureBranchPrefix	String	The prefix for feature branches Default value is: feature/
releaseBranchPrefix	String	The prefix for release branches Default value is: release/
hotfixBranchPrefix	String	The prefix for hotfix branches Default value is: hotfix/
versionTagPrefix	String	The prefix for release tags Default value is: (blank)

pushFeatures

Whether to push feature branches to the remote upstream.

Type: boolean
Required: no
User Property: pushFeatures
Default: false

scmCommentPrefix

The message prefix to use for all SCM changes. Will be appended as is. e.g. getScmMessagePrefix() + the_message;

Type: java.lang.String
Required: no
User Property: scmCommentPrefix
Default: "" (no prefix)

startCommit

A SHA, short SHA, or branch name to use as the starting point for the new branch

Type: java.lang.String
Required: no
User Property: startCommit

Wiki

jgit-flow / goals / feature-start