releaser:next
Full name:
com.github.danielflower.mavenplugins:multi-module-maven-release-plugin:3.6.4:next
Description:
Attributes:
- Requires a Maven project to be executed.
- Executes as an aggregator plugin.
- Executes by direct invocation only.
- The goal is not marked as thread-safe and thus does not support parallel builds.
- Since version:
1.4.0.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<arguments> |
String |
1.4.0 |
Additional arguments to pass to Maven during a release. To pass multiple system properties from the command line, use
To configure arguments in your pom, in the
User property is: arguments. |
<buildNumber> |
Long |
1.4.0 |
The build number to use in the release version. Given a snapshot version of "1.0-SNAPSHOT" and a buildNumber value of "2", the actual released version will be "1.0.2". By default, the plugin will automatically find a suitable build number. It will start at version 0 and increment this with each release. This can be specified using a command line parameter ("-DbuildNumber=2") or in this plugin's configuration. User property is: buildNumber. |
<disableSshAgent> |
boolean |
1.4.0 |
(no description) User property is: disableSshAgent. |
<knownHosts> |
String |
1.4.0 |
If set, this file will be used to specify the known_hosts. This
will override any default value. User property is: knownHosts. |
<modulesToForceRelease> |
List |
1.4.0 |
A module to force release on, even if no changes has been detected. User property is: forceRelease.Alias is: forceRelease. |
<modulesToRelease> |
List |
1.4.0 |
The modules to release, or no value to to release the project from
the root pom, which is the default. The selected module plus any
other modules it needs will be built and released also. When run
from the command line, this can be a comma-separated list of module
names. User property is: modulesToRelease.Alias is: modulesToRelease. |
<noChangesAction> |
NoChangesAction |
1.4.0 |
Determines the action to take when no module changes are detected.
Possible values: ReleaseAll, ReleaseNone,
FailBuildDefault value is: ReleaseAll.User property is: noChangesAction.Alias is: noChangesAction. |
<passphrase> |
String |
1.4.0 |
Specifies the passphrase to be used with the identityFile specified for SSH where the private key requires a pass phrase. To avoid specifying a passphrase in your pom, you could instead
specify a User property is: passphrase. |
<privateKey> |
String |
1.4.0 |
Specifies the private key to be used for SSH URLs. By default it
will use ~/.ssh/id_rsaUser property is: privateKey. |
<pullTags> |
boolean |
1.4.0 |
Fetch tags from remote repository to determine the next build
number. If false, then tags from the local repository will be used
instead. Make sure they are up to date to avoid problems. Default value is: true.User property is: pull.Alias is: pullTags. |
<serverId> |
String |
1.4.0 |
If set, the identityFile and passphrase will be read from the Maven settings file. See https://maven.apache.org/guides/mini/guide-deployment-security-settings.html for more information on configuring servers in Maven. User property is: serverId. |
<versionNamer> |
VersionNamer |
1.4.0 |
Configures the version naming. User property is: versionNamer. |
Parameter Details
<arguments>
Additional arguments to pass to Maven during a release.
To pass multiple system properties from the command line, use
-Darguments="-Dprop.1=prop1value
-Dprop.2=prop2value"
To configure arguments in your pom, in the
<configuration> node add:
<arguments>'-Dprop.1=prop 1 value'
-Dprop.2=prop2value</arguments>
- Type:
java.lang.String - Since:
1.4.0 - Required:
No - User Property:
arguments
<buildNumber>
The build number to use in the release version. Given a snapshot version of "1.0-SNAPSHOT" and a buildNumber value of "2", the actual released version will be "1.0.2".
By default, the plugin will automatically find a suitable build number. It will start at version 0 and increment this with each release.
This can be specified using a command line parameter ("-DbuildNumber=2") or in this plugin's configuration.
- Type:
java.lang.Long - Since:
1.4.0 - Required:
No - User Property:
buildNumber
<disableSshAgent>
- Type:
boolean - Since:
1.4.0 - Required:
No - User Property:
disableSshAgent
<knownHosts>
- Type:
java.lang.String - Since:
1.4.0 - Required:
No - User Property:
knownHosts
<modulesToForceRelease>
- Type:
java.util.List - Since:
1.4.0 - Required:
No - User Property:
forceRelease - Alias:
forceRelease
<modulesToRelease>
- Type:
java.util.List - Since:
1.4.0 - Required:
No - User Property:
modulesToRelease - Alias:
modulesToRelease
<noChangesAction>
ReleaseAll, ReleaseNone,
FailBuild- Type:
com.github.danielflower.mavenplugins.release.NoChangesAction - Since:
1.4.0 - Required:
No - User Property:
noChangesAction - Default:
ReleaseAll - Alias:
noChangesAction
<passphrase>
Specifies the passphrase to be used with the identityFile specified for SSH where the private key requires a pass phrase.
To avoid specifying a passphrase in your pom, you could instead
specify a server in your maven settings file and then
set the serverId property.
- Type:
java.lang.String - Since:
1.4.0 - Required:
No - User Property:
passphrase
<privateKey>
~/.ssh/id_rsa- Type:
java.lang.String - Since:
1.4.0 - Required:
No - User Property:
privateKey
<pullTags>
- Type:
boolean - Since:
1.4.0 - Required:
No - User Property:
pull - Default:
true - Alias:
pullTags
<serverId>
If set, the identityFile and passphrase will be read from the Maven settings file.
See https://maven.apache.org/guides/mini/guide-deployment-security-settings.html for more information on configuring servers in Maven.
- Type:
java.lang.String - Since:
1.4.0 - Required:
No - User Property:
serverId
<versionNamer>
Configures the version naming.
- Type:
com.github.danielflower.mavenplugins.release.VersionNamer - Since:
1.4.0 - Required:
No - User Property:
versionNamer