Built by Maven

release:update-versions

Full name:

org.apache.maven.plugins:maven-release-plugin:3.1.0: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/usage/update-versions.html.

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: 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: true
User Property: addSchema
<arguments> String - Additional arguments to pass to the Maven executions, separated by spaces.
User Property: arguments
Alias: prepareVerifyArgs
<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: false
User Property: autoVersionSubmodules
<developmentVersion> String 2.0 Default version to use for new local working copy.
User Property: developmentVersion
<javaHome> File 2.0-beta-8 The Java home parameter to use for forked Maven invocations.
Default: ${java.home}
<localRepoDirectory> File 2.0-beta-8 The command-line local repository directory in use for this build (if specified).
Default: ${maven.repo.local}
<mavenExecutorId> String 2.0-beta-8 Role hint of the org.apache.maven.shared.release.exec.MavenExecutor implementation to use.
Default: invoker
User Property: mavenExecutorId
<mavenHome> File 2.0-beta-8 The Maven home parameter to use for forked Maven invocations.
Default: ${maven.home}
<pomFileName> String - 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: ${project.file.name}
User Property: pomFileName
<projectVersionPolicyConfig> PlexusConfiguration 3.0.0 Optional config for the VersionPolicy implementation used to calculate the project versions.
User Property: projectVersionPolicyConfig
<projectVersionPolicyId> String 3.0.0-M5 The role-hint for the VersionPolicy implementation used to calculate the project versions.
Default: default
User Property: projectVersionPolicyId
<releaseStrategyId> String 3.0.0-M5 The role-hint for the org.apache.maven.shared.release.strategy.Strategy implementation used to specify the phases per goal.
See also: org.apache.maven.shared.release.strategies.DefaultStrategy
Default: default
User Property: releaseStrategyId
<updateDependencies> boolean 2.5.2 Whether to update dependencies version to the next development version.
Default: true
User Property: updateDependencies
<useEditMode> boolean 2.5.2 Whether to use "edit" mode on the SCM, to lock the file for editing during SCM operations.
Default: false
User Property: 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
  • Required: No
  • User Property: arguments
  • Alias: prepareVerifyArgs

<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 org.apache.maven.shared.release.exec.MavenExecutor implementation to use.
  • Type: java.lang.String
  • Since: 2.0-beta-8
  • Required: No
  • User Property: mavenExecutorId
  • Default: invoker

<mavenHome>

The Maven 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
  • Required: No
  • User Property: pomFileName
  • Default: ${project.file.name}

<projectVersionPolicyConfig>

Optional config for the VersionPolicy implementation used to calculate the project versions.
  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Since: 3.0.0
  • Required: No
  • User Property: projectVersionPolicyConfig

<projectVersionPolicyId>

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

<releaseStrategyId>

The role-hint for the org.apache.maven.shared.release.strategy.Strategy implementation used to specify the phases per goal.
See also: org.apache.maven.shared.release.strategies.DefaultStrategy
  • Type: java.lang.String
  • Since: 3.0.0-M5
  • 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