Versions Maven Plugin – versions:set

versions:set

Full name:

org.codehaus.mojo:versions-maven-plugin:2.5:set

Description:

Sets the current project's version and based on that change propagates that change onto any child modules as necessary.

Attributes:

Requires a Maven project to be executed.
Executes as an aggregator plugin.
Executes by direct invocation only.
Since version: 1.0-beta-1.

Optional Parameters

Name	Type	Since	Description
allowSnapshots	`boolean`	`1.0-alpha-1`	Whether to allow snapshots when searching for the latest version of an artifact. Default value is: `false`. User property is: `allowSnapshots`.
artifactId	`String`	`1.2`	The artifactId of the dependency/module to update. If you like to update modules of a aggregator you should set `-DartifactId=''` to ignore the artifactId of the current project. On Windows you can omit the single quotes on Linux they are necessary to prevent expansion through the shell. Default value is: `${project.artifactId}`. User property is*: `artifactId`.
generateBackupPoms	`boolean`	`1.0-alpha-3`	Controls whether a backup pom should be created. Default value is: `true`. User property is: `generateBackupPoms`.
groupId	`String`	`1.2`	The groupId of the dependency/module to update. If you like to update modules of a aggregator you should set `-DgroupId=''` to ignore the group of the current project. On Windows you can omit the single quotes on Linux they are necessary to prevent expansion through the shell. Default value is: `${project.groupId}`. User property is*: `groupId`.
newVersion	`String`	`1.0-beta-1`	The new version number to set. User property is: `newVersion`.
nextSnapshot	`boolean`	`2.10`	Whether to add next version number and `-SNAPSHOT` to the existing version. Default value is: `false`. User property is: `nextSnapshot`.
oldVersion	`String`	`1.2`	The version of the dependency/module to update. If you are changing an aggregator you should give `-DoldVersion=''` to suppress the check against the version of the current project. On Windows you can omit the single quotes on Linux they are necessary to prevent expansion through the shell. Default value is: `${project.version}`. User property is*: `oldVersion`.
processAllModules	`boolean`	`2.5`	Whether to process all modules whereas they have parent/child or not. Default value is: `false`. User property is: `processAllModules`.
processDependencies	`boolean`	`1.3`	Whether to process the dependencies section of the project. Default value is: `true`. User property is: `processDependencies`.
processParent	`boolean`	`1.3`	Whether to process the parent of the project. Default value is: `true`. User property is: `processParent`.
processPlugins	`boolean`	`1.3`	Whether to process the plugins section of the project. Default value is: `true`. User property is: `processPlugins`.
processProject	`boolean`	`1.3`	Whether to process the project version. Default value is: `true`. User property is: `processProject`.
removeSnapshot	`boolean`	`2.10`	Whether to remove `-SNAPSHOT` from the existing version. Default value is: `false`. User property is: `removeSnapshot`.
rulesUri	`String`	`1.0-alpha-3`	URI of a ruleSet file containing the rules that control how to compare version numbers. The URI could be either a Wagon URI or a classpath URI (e.g. `classpath:///package/sub/package/rules.xml`). User property is: `maven.version.rules`.
serverId	`String`	`1.0-alpha-3`	settings.xml's server id for the URL. This is used when wagon needs extra authentication information. Default value is: `serverId`. User property is: `maven.version.rules.serverId`.
updateMatchingVersions	`boolean`	`1.3`	Whether matching versions explicitly specified (as /project/version) in child modules should be updated. Default value is: `true`. User property is: `updateMatchingVersions`.

Parameter Details

allowSnapshots:

Whether to allow snapshots when searching for the latest version of an artifact.

Type: boolean
Since: 1.0-alpha-1
Required: No
User Property: allowSnapshots
Default: false

artifactId:

The artifactId of the dependency/module to update. If you like to update modules of a aggregator you should set -DartifactId='*' to ignore the artifactId of the current project. On Windows you can omit the single quotes on Linux they are necessary to prevent expansion through the shell.

Type: java.lang.String
Since: 1.2
Required: No
User Property: artifactId
Default: ${project.artifactId}

generateBackupPoms:

Controls whether a backup pom should be created.

Type: boolean
Since: 1.0-alpha-3
Required: No
User Property: generateBackupPoms
Default: true

groupId:

The groupId of the dependency/module to update. If you like to update modules of a aggregator you should set -DgroupId='*' to ignore the group of the current project. On Windows you can omit the single quotes on Linux they are necessary to prevent expansion through the shell.

Type: java.lang.String
Since: 1.2
Required: No
User Property: groupId
Default: ${project.groupId}

newVersion:

The new version number to set.

Type: java.lang.String
Since: 1.0-beta-1
Required: No
User Property: newVersion

nextSnapshot:

Whether to add next version number and -SNAPSHOT to the existing version.

Type: boolean
Since: 2.10
Required: No
User Property: nextSnapshot
Default: false

oldVersion:

The version of the dependency/module to update. If you are changing an aggregator you should give -DoldVersion='*' to suppress the check against the version of the current project. On Windows you can omit the single quotes on Linux they are necessary to prevent expansion through the shell.

Type: java.lang.String
Since: 1.2
Required: No
User Property: oldVersion
Default: ${project.version}

processAllModules:

Whether to process all modules whereas they have parent/child or not.

Type: boolean
Since: 2.5
Required: No
User Property: processAllModules
Default: false

processDependencies:

Whether to process the dependencies section of the project.

Type: boolean
Since: 1.3
Required: No
User Property: processDependencies
Default: true

processParent:

Whether to process the parent of the project.

Type: boolean
Since: 1.3
Required: No
User Property: processParent
Default: true

processPlugins:

Whether to process the plugins section of the project.

Type: boolean
Since: 1.3
Required: No
User Property: processPlugins
Default: true

processProject:

Whether to process the project version.

Type: boolean
Since: 1.3
Required: No
User Property: processProject
Default: true

removeSnapshot:

Whether to remove -SNAPSHOT from the existing version.

Type: boolean
Since: 2.10
Required: No
User Property: removeSnapshot
Default: false

rulesUri:

URI of a ruleSet file containing the rules that control how to compare version numbers. The URI could be either a Wagon URI or a classpath URI (e.g. classpath:///package/sub/package/rules.xml).

Type: java.lang.String
Since: 1.0-alpha-3
Required: No
User Property: maven.version.rules

serverId:

settings.xml's server id for the URL. This is used when wagon needs extra authentication information.

Type: java.lang.String
Since: 1.0-alpha-3
Required: No
User Property: maven.version.rules.serverId
Default: serverId

updateMatchingVersions:

Whether matching versions explicitly specified (as /project/version) in child modules should be updated.

Type: boolean
Since: 1.3
Required: No
User Property: updateMatchingVersions
Default: true