releaser:next

Full name:

com.github.danielflower.mavenplugins:multi-module-maven-release-plugin:3.7.8:next

Description:

Logs the versions of the modules that the releaser will release on the next release. Does not run the build nor tag the repo.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator goal.
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`	`-`	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>` User Property: `arguments`
`<buildNumber>`	`Long`	`-`	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: `buildNumber`
`<disableSshAgent>`	`boolean`	`-`	No description. User Property: `disableSshAgent`
`<knownHosts>`	`String`	`-`	If set, this file will be used to specify the known_hosts. This will override any default value. User Property: `knownHosts`
`<modulesToForceRelease>`	`List<String>`	`-`	A module to force release on, even if no changes has been detected. User Property: `forceRelease` Alias: `forceRelease`
`<modulesToRelease>`	`List<String>`	`-`	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: `modulesToRelease` Alias: `modulesToRelease`
`<noChangesAction>`	`NoChangesAction`	`-`	Determines the action to take when no module changes are detected. Possible values: `ReleaseAll`, `ReleaseNone`, `FailBuild` Default: `ReleaseAll` User Property: `noChangesAction` Alias: `noChangesAction`
`<passphrase>`	`String`	`-`	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. User Property: `passphrase`
`<privateKey>`	`String`	`-`	Specifies the private key to be used for SSH URLs. By default it will use `~/.ssh/id_rsa` User Property: `privateKey`
`<pullTags>`	`boolean`	`-`	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: `true` User Property: `pull` Alias: `pullTags`
`<serverId>`	`String`	`-`	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: `serverId`
`<versionNamer>`	`VersionNamer`	`-`	Configures the version naming. User Property: `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
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
Required: No
User Property: buildNumber

<disableSshAgent>

No description.

Type: boolean
Required: No
User Property: disableSshAgent

<knownHosts>

If set, this file will be used to specify the known_hosts. This will override any default value.

Type: java.lang.String
Required: No
User Property: knownHosts

<modulesToForceRelease>

A module to force release on, even if no changes has been detected.

Type: java.util.List<java.lang.String>
Required: No
User Property: forceRelease
Alias: forceRelease

<modulesToRelease>

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.

Type: java.util.List<java.lang.String>
Required: No
User Property: modulesToRelease
Alias: modulesToRelease

<noChangesAction>

Determines the action to take when no module changes are detected. Possible values: ReleaseAll, ReleaseNone, FailBuild

Type: com.github.danielflower.mavenplugins.release.NoChangesAction
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
Required: No
User Property: passphrase

<privateKey>

Specifies the private key to be used for SSH URLs. By default it will use ~/.ssh/id_rsa

Type: java.lang.String
Required: No
User Property: privateKey

<pullTags>

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.

Type: boolean
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
Required: No
User Property: serverId

<versionNamer>

Configures the version naming.

Type: com.github.danielflower.mavenplugins.release.VersionNamer
Required: No
User Property: versionNamer