jgitflow:feature-start | JGit Flow Maven Plugin

Full name:

external.atlassian.jgitflow:jgitflow-maven-plugin:1.0-m5.1:feature-start

Description:

(no description)

Attributes:

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

Optional Parameters

Name	Type	Since	Description
allowSnapshots	`boolean`	`version`	Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT. Default value is: `false`. User property is: `allowSnapshots`.
allowUntracked	`boolean`	`version`	Whether to allow untracked files when checking if the working tree is clean. Default value is: `false`. User property is: `allowUntracked`.
alwaysUpdateOrigin	`boolean`	`version`	Whether to always overwrite the origin url in the .git/config file This is useful to ensure the proper origin url is used in CI environments Default value is: `true`. User property is: `alwaysUpdateOrigin`.
defaultOriginUrl	`String`	`version`	Default url to use if origin remote is not found in .git/config. This is highly useful for CI servers that don't do proper clones. User property is: `defaultOriginUrl`.
enableFeatureVersions	`boolean`	`version`	Whether to append the feature name to the version on the feature branch. Default value is: `false`. User property is: `enableFeatureVersions`.
enableSshAgent	`boolean`	`version`	Whether to enable using an ssh-agent. Default value is: `false`. User property is: `enableSshAgent`.
eol	`String`	`version`	This can be used to force the type of line ending used when rewriting poms. If not set, blank or has an invalid value, the eol will be looked up from core.eol Valid values are: native, lf, crlf User property is: `eol`.
featureName	`String`	`version`	Default name of the feature. This option is primarily useful when starting the goal in non-interactive mode. User property is: `featureName`.
flowInitContext	`FlowInitContext`	`version`	This parameter permits you to configure branch and tag names, as shown in the following example: <flowInitContext> <masterBranchName>master</masterBranchName> <developBranchName>develop</developBranchName> <featureBranchPrefix>feature-</featureBranchPrefix> <releaseBranchPrefix>release-</releaseBranchPrefix> <hotfixBranchPrefix>hotfix-</hotfixBranchPrefix> <versionTagPrefix>stable-</versionTagPrefix> </flowInitContext> Default value is: `${flowInitContext}`.
localOnly	`boolean`	`version`	Whether to turn off all operations access the remote git repository. This will still allow network access to download dependencies and such. NOTE: THIS IS NOT CURRENTLY IMPLEMENTED! Default value is: `false`. User property is: `localOnly`.
offline	`boolean`	`version`	Whether to turn off all operations that require network access. NOTE: THIS IS NOT CURRENTLY IMPLEMENTED! Default value is: `${settings.offline}`. User property is: `offline`.
password	`String`	`version`	The password to use when using user/pass authentication User property is: `password`.
pullDevelop	`boolean`	`version`	Whether to pull the develop branch when jgitflow is initialized Default value is: `false`. User property is: `pullDevelop`.
pullMaster	`boolean`	`version`	Whether to pull the master branch when jgitflow is initialized Default value is: `false`. User property is: `pullMaster`.
pushFeatures	`boolean`	`version`	Whether to push feature branches to the remote upstream. Default value is: `false`. User property is: `pushFeatures`.
scmCommentPrefix	`String`	`version`	The message prefix to use for all SCM changes. User property is: `scmCommentPrefix`.
scmCommentSuffix	`String`	`version`	The message suffix to use for all SCM changes. User property is: `scmCommentSuffix`.
startCommit	`String`	`version`	A SHA, short SHA, or branch name to use as the starting point for the new branch User property is: `startCommit`.
username	`String`	`version`	The username to use when using user/pass authentication User property is: `username`.

Parameter Details

allowSnapshots:

Whether to allow SNAPSHOT dependencies. Default is to fail when finding any SNAPSHOT.

Type: boolean
Since: version
Required: No
User Property: allowSnapshots
Default: false

allowUntracked:

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

Type: boolean
Since: version
Required: No
User Property: allowUntracked
Default: false

alwaysUpdateOrigin:

Whether to always overwrite the origin url in the .git/config file This is useful to ensure the proper origin url is used in CI environments

Type: boolean
Since: version
Required: No
User Property: alwaysUpdateOrigin
Default: true

defaultOriginUrl:

Default url to use if origin remote is not found in .git/config. This is highly useful for CI servers that don't do proper clones.

Type: java.lang.String
Since: version
Required: No
User Property: defaultOriginUrl

enableFeatureVersions:

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

Type: boolean
Since: version
Required: No
User Property: enableFeatureVersions
Default: false

enableSshAgent:

Whether to enable using an ssh-agent.

Type: boolean
Since: version
Required: No
User Property: enableSshAgent
Default: false

eol:

This can be used to force the type of line ending used when rewriting poms. If not set, blank or has an invalid value, the eol will be looked up from core.eol Valid values are: native, lf, crlf

Type: java.lang.String
Since: version
Required: No
User Property: eol

featureName:

Default name of the feature. This option is primarily useful when starting the goal in non-interactive mode.

Type: java.lang.String
Since: version
Required: No
User Property: featureName

flowInitContext:

This parameter permits you to configure branch and tag names, as shown in the following example:

<flowInitContext>
  <masterBranchName>master</masterBranchName>
  <developBranchName>develop</developBranchName>
  <featureBranchPrefix>feature-</featureBranchPrefix>
  <releaseBranchPrefix>release-</releaseBranchPrefix>
  <hotfixBranchPrefix>hotfix-</hotfixBranchPrefix>
  <versionTagPrefix>stable-</versionTagPrefix>
</flowInitContext>

Type: com.atlassian.maven.plugins.jgitflow.FlowInitContext
Since: version
Required: No
Default: ${flowInitContext}

localOnly:

Whether to turn off all operations access the remote git repository. This will still allow network access to download dependencies and such.

NOTE: THIS IS NOT CURRENTLY IMPLEMENTED!

Type: boolean
Since: version
Required: No
User Property: localOnly
Default: false