Maven JGit-Flow Plugin

Release Start

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

Short name: jgitflow:release-start

Description: Prepares the project for a release. Creates a release branch and updates pom(s) with the release 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.
autoVersionSubmodules	boolean	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	Default url to use if origin remote is not found in .git/config. User property is: defaultOriginUrl.
developmentVersion	String	Default development version to use following the start of the release. User property is: developmentVersion.
enableSshAgent	boolean	Whether to enable using an ssh-agent. Default value is: false. User property is: enableSshAgent.
flowInitContext	FlowInitContext	Used to override default git-flow branch names and prefixes
pushReleases	boolean	Whether to push release branches to the remote upstream. Default value is: false. User property is: pushReleases.
releaseBranchVersionSuffix	String	Suffix to append to versions on the release branch. User property is: releaseBranchVersionSuffix.
releaseVersion	String	Default version to use when starting a release. User property is: releaseVersion.
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.
updateDependencies	boolean	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	Sets the username for the CredentialsProvider. Default value is: "".
password	String	Sets the password for the CredentialsProvider. Default value is: "".

Parameter Details

allowSnapshots

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

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

allowUntracked

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

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

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
Required: no
User Property: autoVersionSubmodules
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

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)

pushReleases

Whether to push release branches to the remote upstream.

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

releaseBranchVersionSuffix

Suffix to append to versions on the release branch.

For example if the releaseBranchVersionSuffix is set to "RC", the version on the release branch would look like: 1.0-RC-SNAPSHOT

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

releaseVersion

Default version to use when starting a release.

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

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

updateDependencies

Whether to update dependencies version to the release version.

Type: boolean
Required: no
User Property: updateDependencies
Default: true

Wiki

jgit-flow / goals / release-start