JGit Flow Maven Plugin

jgitflow:release-start

Full name:

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

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: test.
  • 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.
autoVersionSubmodules boolean version Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the version of each submodules.
Default value is: false.
User property is: autoVersionSubmodules.
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.
developmentVersion String version Default version to use for new local working copy.
User property is: developmentVersion.
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.
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.
pushReleases boolean version Whether to push release branches to the remote upstream.
Default value is: false.
User property is: pushReleases.
releaseBranchVersionSuffix String version Suffix to append to versions on the release branch.
User property is: releaseBranchVersionSuffix.
releaseStartExtension String version A FQCN of a compatible release start extension. Extensions are used to run custom code at various points in the jgitflow lifecycle. More documentation on using extensions will be available in the future
releaseVersion String version Default version to use when preparing a release
User property is: releaseVersion.
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.
updateDependencies boolean version Whether, for modules which refer to each other within the same multi-module build, to update dependencies version to the release version.
Default value is: true.
User property is: updateDependencies.
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

autoVersionSubmodules:

Whether to automatically assign submodules the parent version. If set to false, the user will be prompted for the version of each submodules.
  • Type: boolean
  • Since: version
  • Required: No
  • User Property: autoVersionSubmodules
  • Default: false

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

developmentVersion:

Default version to use for new local working copy.
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: developmentVersion

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

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

offline:

Whether to turn off all operations that require network access. NOTE: THIS IS NOT CURRENTLY IMPLEMENTED!
  • Type: boolean
  • Since: version
  • Required: No
  • User Property: offline
  • Default: ${settings.offline}

password:

The password to use when using user/pass authentication
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: password

pullDevelop:

Whether to pull the develop branch when jgitflow is initialized
  • Type: boolean
  • Since: version
  • Required: No
  • User Property: pullDevelop
  • Default: false

pullMaster:

Whether to pull the master branch when jgitflow is initialized
  • Type: boolean
  • Since: version
  • Required: No
  • User Property: pullMaster
  • Default: false

pushReleases:

Whether to push release branches to the remote upstream.
  • Type: boolean
  • Since: version
  • Required: No
  • User Property: pushReleases
  • Default: false

releaseBranchVersionSuffix:

Suffix to append to versions on the release branch.
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: releaseBranchVersionSuffix

releaseStartExtension:

A FQCN of a compatible release start extension. Extensions are used to run custom code at various points in the jgitflow lifecycle. More documentation on using extensions will be available in the future
  • Type: java.lang.String
  • Since: version
  • Required: No

releaseVersion:

Default version to use when preparing a release
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: releaseVersion

scmCommentPrefix:

The message prefix to use for all SCM changes.
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: scmCommentPrefix

scmCommentSuffix:

The message suffix to use for all SCM changes.
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: scmCommentSuffix

startCommit:

A SHA, short SHA, or branch name to use as the starting point for the new branch
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: startCommit

updateDependencies:

Whether, for modules which refer to each other within the same multi-module build, to update dependencies version to the release version.
  • Type: boolean
  • Since: version
  • Required: No
  • User Property: updateDependencies
  • Default: true

username:

The username to use when using user/pass authentication
  • Type: java.lang.String
  • Since: version
  • Required: No
  • User Property: username

Back to top

Copyright ©2015 Atlassian. All Rights Reserved.

Reflow Maven skin by Andrius Velykis.