Built by Maven

release:update-versions

Full name:

org.apache.maven.plugins:maven-release-plugin:3.0.0-M1:update-versions

Description:

Update the POM versions for a project. This performs the normal version updates of the release:prepare goal without making other modifications to the SCM such as tagging. For more info see https://maven.apache.org/plugins/maven-release-plugin/examples/update-versions.html.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
addSchema boolean 2.0 Whether to add a schema to the POM if it was previously missing on release.
Default value is: true.
User property is: addSchema.
arguments String 2.0 Additional arguments to pass to the Maven executions, separated by spaces.
User property is: arguments.
autoVersionSubmodules boolean 2.0 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.
developmentVersion String 2.0 Default version to use for new local working copy.
User property is: developmentVersion.
javaHome File 2.0-beta-8 The JAVA_HOME parameter to use for forked Maven invocations.
Default value is: ${java.home}.
localRepoDirectory File 2.0-beta-8 The command-line local repository directory in use for this build (if specified).
Default value is: ${maven.repo.local}.
mavenExecutorId String 2.0-beta-8 Role hint of the MavenExecutor implementation to use.
Default value is: invoker.
User property is: mavenExecutorId.
mavenHome File 2.0-beta-8 The M2_HOME parameter to use for forked Maven invocations.
Default value is: ${maven.home}.
pomFileName String 2.0 The file name of the POM to execute any goals against. As of version 3.0.0, this defaults to the name of POM file of the project being built.
Default value is: ${project.file.name}.
User property is: pomFileName.
projectVersionPolicyId String 3.0.0 The role-hint for the VersionPolicy implementation used to calculate the project versions.
Default value is: default.
User property is: projectVersionPolicyId.
releaseStrategyId String 3.0.0 The role-hint for the Strategy implementation used to specify the phases per goal.
Default value is: default.
User property is: releaseStrategyId.
updateDependencies boolean 2.5.2 Whether to update dependencies version to the next development version.
Default value is: true.
User property is: updateDependencies.
useEditMode boolean 2.5.2 Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations.
Default value is: false.
User property is: useEditMode.

Parameter Details

addSchema:

Whether to add a schema to the POM if it was previously missing on release.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: addSchema
  • Default: true

arguments:

Additional arguments to pass to the Maven executions, separated by spaces.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: arguments

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
  • Since: 2.0
  • Required: No
  • User Property: autoVersionSubmodules
  • Default: false

developmentVersion:

Default version to use for new local working copy.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: developmentVersion

javaHome:

The JAVA_HOME parameter to use for forked Maven invocations.
  • Type: java.io.File
  • Since: 2.0-beta-8
  • Required: No
  • Default: ${java.home}

localRepoDirectory:

The command-line local repository directory in use for this build (if specified).
  • Type: java.io.File
  • Since: 2.0-beta-8
  • Required: No
  • Default: ${maven.repo.local}

mavenExecutorId:

Role hint of the MavenExecutor implementation to use.
  • Type: java.lang.String
  • Since: 2.0-beta-8
  • Required: No
  • User Property: mavenExecutorId
  • Default: invoker

mavenHome:

The M2_HOME parameter to use for forked Maven invocations.
  • Type: java.io.File
  • Since: 2.0-beta-8
  • Required: No
  • Default: ${maven.home}

pomFileName:

The file name of the POM to execute any goals against. As of version 3.0.0, this defaults to the name of POM file of the project being built.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: pomFileName
  • Default: ${project.file.name}

projectVersionPolicyId:

The role-hint for the VersionPolicy implementation used to calculate the project versions.
  • Type: java.lang.String
  • Since: 3.0.0
  • Required: No
  • User Property: projectVersionPolicyId
  • Default: default

releaseStrategyId:

The role-hint for the Strategy implementation used to specify the phases per goal.
  • Type: java.lang.String
  • Since: 3.0.0
  • Required: No
  • User Property: releaseStrategyId
  • Default: default

updateDependencies:

Whether to update dependencies version to the next development version.
  • Type: boolean
  • Since: 2.5.2
  • Required: No
  • User Property: updateDependencies
  • Default: true

useEditMode:

Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations.
  • Type: boolean
  • Since: 2.5.2
  • Required: No
  • User Property: useEditMode
  • Default: false