Maven JGit-Flow Plugin

Release Finish

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

Short name: jgitflow:release-finish

Description: Releases the project. Builds the project, Merges the release branch (as per git-flow), optionally pushes changes and updates pom(s) to new development 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.
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
keepBranch	boolean	Whether to keep the release branch after finishing the release. Default value is: false. User property is: keepBranch.
noReleaseBuild	boolean	Whether to turn off project building. If true the project will NOT be built during release finish Default value is: false. User property is: noReleaseBuild.
noDeploy	boolean	Whether to turn off maven deployment. If false the "deploy" goal is called. If true the "install" goal is called Default value is: false. User property is: noDeploy.
noReleaseMerge	boolean	Whether to turn off merging changes from the release branch to master and develop Default value is: false. User property is: noReleaseMerge.
noTag	boolean	Whether to turn off tagging the release in git. Default value is: false. User property is: noTag.
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.
scmCommentPrefix	String	The message prefix to use for all SCM changes. Default value is: "" User property is: scmCommentPrefix.
squash	boolean	Whether to squash commits into a single commit before merging. Default value is: false. User property is: squash.
tagMessage	String	Commit message to use when tagging the release. Default value is: "tagging release ${version}".
updateDependencies	boolean	Whether to update dependencies version to the development version. Default value is: true. User property is: updateDependencies.
useReleaseProfile	boolean	Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, the plugin sets the property "performRelease" to true, which activates the profile "release-profile", which is inherited from the super pom. Default value is: true. User property is: useReleaseProfile.

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

developmentVersion

Default development version to use when finishing a release.

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

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)

keepBranch

Whether to keep the release branch after finishing the release.

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

noReleaseBuild

Whether to turn off project building. If true the project will NOT be built during release finish

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

noDeploy

Whether to turn off maven deployment. If false the "deploy" goal is called. If true the "install" goal is called

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

noReleaseMerge

Whether to turn off merging changes from the release branch to master and develop

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

noTag

Whether to turn off tagging the release in git.

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

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

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)

squash

Whether to squash commits into a single commit before merging.

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

tagMessage

Commit message to use when tagging the release.

Type: java.lang.String
Required: no
Default: "tagging release ${version}"

updateDependencies

Whether to update dependencies version to the release version.

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

useReleaseProfile

Whether to use the release profile that adds sources and javadocs to the released artifact, if appropriate. If set to true, the plugin sets the property "performRelease" to true, which activates the profile "release-profile", which is inherited from the super pom.

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

Wiki

jgit-flow / goals / release-finish