gitflow:release
Full name:
com.amashchenko.maven.plugin:gitflow-maven-plugin:1.21.0:release
Description:
The git flow release mojo.
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator goal.
- The goal is not marked as thread-safe and thus does not support parallel builds.
- Since version:
1.2.0.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<allowSnapshots> |
boolean |
1.2.2 |
Whether to allow SNAPSHOT versions in dependencies. Default value is: false.User property is: allowSnapshots. |
<argLine> |
String |
1.8.0 |
Command line arguments to pass to the underlying Maven commands. User property is: argLine. |
<commitMessagePrefix> |
String |
1.14.0 |
Prefix that is applied to commit messages. User property is: commitMessagePrefix. |
<commitMessages> |
CommitMessages |
1.2.1 |
Git commit messages. Default value is: ${commitMessages}. |
<developmentVersion> |
String |
1.6.0 |
Development version to use instead of the default next development version in non interactive mode. User property is: developmentVersion. |
<digitsOnlyDevVersion> |
boolean |
1.6.0 |
Whether to remove qualifiers from the next development version. Default value is: false.User property is: digitsOnlyDevVersion. |
<fetchRemote> |
boolean |
1.3.0 |
Whether to fetch remote branch and compare it with the local one. Default value is: true.User property is: fetchRemote. |
<gitExecutable> |
String |
- |
The path to the Git executable. Defaults to "git". User property is: gitExecutable. |
<gitFlowConfig> |
GitFlowConfig |
- |
Git flow configuration. Default value is: ${gitFlowConfig}. |
<gitPushOptions> |
String |
1.18.0 |
Options to pass to Git push command using --push-option. Multiple options can be added separated with a space e.g. -DgitPushOptions="merge_request.create merge_request.target=develop merge_request.label='Super feature'"User property is: gitPushOptions. |
<gpgSignCommit> |
boolean |
1.9.0 |
Whether to make a GPG-signed commit. Default value is: false.User property is: gpgSignCommit. |
<gpgSignTag> |
boolean |
1.9.0 |
Whether to make a GPG-signed tag. Default value is: false.User property is: gpgSignTag. |
<installProject> |
boolean |
1.0.5 |
Whether to call Maven install goal during the mojo execution. Default value is: false.User property is: installProject. |
<mvnExecutable> |
String |
- |
The path to the Maven executable. Defaults to "mvn". User property is: mvnExecutable. |
<noBackMerge> |
boolean |
1.20.0 |
Controls which branch is merged to development branch. If set to true then merge will be skipped. If set to false and tag is present (skipTag is set to false) then tag will be merged. If there is no tag then production branch will be merged to development branch.Default value is: false.User property is: noBackMerge. |
<postReleaseGoals> |
String |
1.8.0 |
Maven goals to execute after the release. User property is: postReleaseGoals. |
<preReleaseGoals> |
String |
1.8.0 |
Maven goals to execute before the release. User property is: preReleaseGoals. |
<projectVersionPolicyId> |
String |
1.18.0 |
The role-hint for the org.apache.maven.shared.release.policy.version.VersionPolicy implementation used to calculate the project versions. If a policy is set other parameters controlling the generation of version are ignored (digitsOnlyDevVersion, versionDigitToIncrement).User property is: projectVersionPolicyId. |
<pushRemote> |
boolean |
1.3.0 |
Whether to push to the remote. Default value is: true.User property is: pushRemote. |
<releaseMergeFFOnly> |
boolean |
1.4.0 |
Whether to use --ff-only option when merging.Default value is: false.User property is: releaseMergeFFOnly. |
<releaseMergeNoFF> |
boolean |
1.2.3 |
Whether to use --no-ff option when merging.Default value is: true.User property is: releaseMergeNoFF. |
<releaseRebase> |
boolean |
1.2.3 |
Whether to rebase branch or merge. If true then rebase will be performed.Default value is: false.User property is: releaseRebase. |
<releaseVersion> |
String |
1.3.1 |
Release version to use instead of the default next release version in non interactive mode. User property is: releaseVersion. |
<skipReleaseMergeProdBranch> |
boolean |
1.15.0 |
Whether to skip merging release into the production branch. Default value is: false.User property is: skipReleaseMergeProdBranch. |
<skipTag> |
boolean |
- |
Whether to skip tagging the release in Git. Default value is: false.User property is: skipTag. |
<skipTestProject> |
boolean |
1.0.5 |
Whether to skip calling Maven test goal before releasing. Default value is: false.User property is: skipTestProject. |
<skipUpdateVersion> |
boolean |
1.13.0 |
Whether to skip updating version. Useful with versionProperty to be able to update revision property without modifying version tag.User property is: skipUpdateVersion. |
<tychoBuild> |
boolean |
1.1.0 |
Whether this is Tycho build. Default value is: false. |
<tychoVersionsPluginVersion> |
String |
1.18.0 |
Version of tycho-versions-plugin to use. Default value is: 1.7.0.User property is: tychoVersionsPluginVersion. |
<updateGitSubmodules> |
Boolean |
1.19.0 |
Explicitly enable or disable executing Git submodule update before commit. By default plugin tries to automatically determine if update of the Git submodules is needed. User property is: updateGitSubmodules. |
<updateOutputTimestamp> |
boolean |
1.17.0 |
Whether to update the project.build.outputTimestamp property automatically or not.Default value is: true.User property is: updateOutputTimestamp. |
<verbose> |
boolean |
1.0.7 |
Whether to print commands output into the console. Default value is: false.User property is: verbose. |
<versionDigitToIncrement> |
Integer |
1.6.0 |
Which digit to increment in the next development version. Starts from zero. User property is: versionDigitToIncrement. |
<versionProperty> |
String |
1.13.0 |
Property to set version to. User property is: versionProperty. |
<versionsForceUpdate> |
boolean |
1.10.0 |
Whether to set -DgroupId='*' -DartifactId='*' when calling versions-maven-plugin. Default value is: false.User property is: versionsForceUpdate. |
<versionsMavenPluginVersion> |
String |
1.18.0 |
Version of versions-maven-plugin to use. Default value is: 2.16.0.User property is: versionsMavenPluginVersion. |
Parameter Details
<allowSnapshots>
Whether to allow SNAPSHOT versions in dependencies.
- Type:
boolean - Since:
1.2.2 - Required:
No - User Property:
allowSnapshots - Default:
false
<argLine>
Command line arguments to pass to the underlying Maven commands.
- Type:
java.lang.String - Since:
1.8.0 - Required:
No - User Property:
argLine
<commitMessagePrefix>
Prefix that is applied to commit messages.
- Type:
java.lang.String - Since:
1.14.0 - Required:
No - User Property:
commitMessagePrefix
<commitMessages>
Git commit messages.
- Type:
com.amashchenko.maven.plugin.gitflow.CommitMessages - Since:
1.2.1 - Required:
No - Default:
${commitMessages}
<developmentVersion>
Development version to use instead of the default next development version in non interactive mode.
- Type:
java.lang.String - Since:
1.6.0 - Required:
No - User Property:
developmentVersion
<digitsOnlyDevVersion>
Whether to remove qualifiers from the next development version.
- Type:
boolean - Since:
1.6.0 - Required:
No - User Property:
digitsOnlyDevVersion - Default:
false
<fetchRemote>
Whether to fetch remote branch and compare it with the local one.
- Type:
boolean - Since:
1.3.0 - Required:
No - User Property:
fetchRemote - Default:
true
<gitExecutable>
The path to the Git executable. Defaults to "git".
- Type:
java.lang.String - Required:
No - User Property:
gitExecutable
<gitFlowConfig>
Git flow configuration.
- Type:
com.amashchenko.maven.plugin.gitflow.GitFlowConfig - Required:
No - Default:
${gitFlowConfig}
<gitPushOptions>
Options to pass to Git push command using
--push-option. Multiple options can be added separated with a space e.g. -DgitPushOptions="merge_request.create merge_request.target=develop merge_request.label='Super feature'"- Type:
java.lang.String - Since:
1.18.0 - Required:
No - User Property:
gitPushOptions
<gpgSignCommit>
Whether to make a GPG-signed commit.
- Type:
boolean - Since:
1.9.0 - Required:
No - User Property:
gpgSignCommit - Default:
false
<gpgSignTag>
Whether to make a GPG-signed tag.
- Type:
boolean - Since:
1.9.0 - Required:
No - User Property:
gpgSignTag - Default:
false
<installProject>
Whether to call Maven install goal during the mojo execution.
- Type:
boolean - Since:
1.0.5 - Required:
No - User Property:
installProject - Default:
false
<mvnExecutable>
The path to the Maven executable. Defaults to "mvn".
- Type:
java.lang.String - Required:
No - User Property:
mvnExecutable
<noBackMerge>
Controls which branch is merged to development branch. If set to
true then merge will be skipped. If set to false and tag is present (skipTag is set to false) then tag will be merged. If there is no tag then production branch will be merged to development branch.- Type:
boolean - Since:
1.20.0 - Required:
No - User Property:
noBackMerge - Default:
false
<postReleaseGoals>
Maven goals to execute after the release.
- Type:
java.lang.String - Since:
1.8.0 - Required:
No - User Property:
postReleaseGoals
<preReleaseGoals>
Maven goals to execute before the release.
- Type:
java.lang.String - Since:
1.8.0 - Required:
No - User Property:
preReleaseGoals
<projectVersionPolicyId>
The role-hint for the
org.apache.maven.shared.release.policy.version.VersionPolicy implementation used to calculate the project versions. If a policy is set other parameters controlling the generation of version are ignored (digitsOnlyDevVersion, versionDigitToIncrement).- Type:
java.lang.String - Since:
1.18.0 - Required:
No - User Property:
projectVersionPolicyId
<pushRemote>
Whether to push to the remote.
- Type:
boolean - Since:
1.3.0 - Required:
No - User Property:
pushRemote - Default:
true
<releaseMergeFFOnly>
Whether to use
--ff-only option when merging.- Type:
boolean - Since:
1.4.0 - Required:
No - User Property:
releaseMergeFFOnly - Default:
false
<releaseMergeNoFF>
Whether to use
--no-ff option when merging.- Type:
boolean - Since:
1.2.3 - Required:
No - User Property:
releaseMergeNoFF - Default:
true
<releaseRebase>
Whether to rebase branch or merge. If
true then rebase will be performed.- Type:
boolean - Since:
1.2.3 - Required:
No - User Property:
releaseRebase - Default:
false
<releaseVersion>
Release version to use instead of the default next release version in non interactive mode.
- Type:
java.lang.String - Since:
1.3.1 - Required:
No - User Property:
releaseVersion
<skipReleaseMergeProdBranch>
Whether to skip merging release into the production branch.
- Type:
boolean - Since:
1.15.0 - Required:
No - User Property:
skipReleaseMergeProdBranch - Default:
false
<skipTag>
Whether to skip tagging the release in Git.
- Type:
boolean - Required:
No - User Property:
skipTag - Default:
false
<skipTestProject>
Whether to skip calling Maven test goal before releasing.
- Type:
boolean - Since:
1.0.5 - Required:
No - User Property:
skipTestProject - Default:
false
<skipUpdateVersion>
Whether to skip updating version. Useful with
versionProperty to be able to update revision property without modifying version tag.- Type:
boolean - Since:
1.13.0 - Required:
No - User Property:
skipUpdateVersion
<tychoBuild>
Whether this is Tycho build.
- Type:
boolean - Since:
1.1.0 - Required:
No - Default:
false
<tychoVersionsPluginVersion>
Version of tycho-versions-plugin to use.
- Type:
java.lang.String - Since:
1.18.0 - Required:
No - User Property:
tychoVersionsPluginVersion - Default:
1.7.0
<updateGitSubmodules>
Explicitly enable or disable executing Git submodule update before commit. By default plugin tries to automatically determine if update of the Git submodules is needed.
- Type:
java.lang.Boolean - Since:
1.19.0 - Required:
No - User Property:
updateGitSubmodules
<updateOutputTimestamp>
Whether to update the
project.build.outputTimestamp property automatically or not.- Type:
boolean - Since:
1.17.0 - Required:
No - User Property:
updateOutputTimestamp - Default:
true
<verbose>
Whether to print commands output into the console.
- Type:
boolean - Since:
1.0.7 - Required:
No - User Property:
verbose - Default:
false
<versionDigitToIncrement>
Which digit to increment in the next development version. Starts from zero.
- Type:
java.lang.Integer - Since:
1.6.0 - Required:
No - User Property:
versionDigitToIncrement
<versionProperty>
Property to set version to.
- Type:
java.lang.String - Since:
1.13.0 - Required:
No - User Property:
versionProperty
<versionsForceUpdate>
Whether to set -DgroupId='*' -DartifactId='*' when calling versions-maven-plugin.
- Type:
boolean - Since:
1.10.0 - Required:
No - User Property:
versionsForceUpdate - Default:
false
<versionsMavenPluginVersion>
Version of versions-maven-plugin to use.
- Type:
java.lang.String - Since:
1.18.0 - Required:
No - User Property:
versionsMavenPluginVersion - Default:
2.16.0