Fork me on GitHub
Built by Maven

versions:update-parent

Full name:

org.codehaus.mojo:versions-maven-plugin:2.20.1:update-parent

Description:

Sets the parent version to the latest parent version.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0-alpha-1.

Optional Parameters

Name Type Since Description
<allowDowngrade> boolean 2.12.0

Whether to downgrade a snapshot dependency if allowSnapshots is false and there exists a version within the range fulfilling the criteria.

Default false


Default: false
User Property: allowDowngrade
<allowIncrementalUpdates> boolean 2.13.0

Whether to allow the incremental version number to be changed.

Note: false also implies allowMajorUpdates and allowMinorUpdates false


Default: true
User Property: allowIncrementalUpdates
<allowMajorUpdates> boolean 2.13.0 Whether to allow the major version number to be changed.
Default: true
User Property: allowMajorUpdates
<allowMinorUpdates> boolean 2.13.0

Whether to allow the minor version number to be changed.

Note: false also implies allowMajorUpdates false


Default: true
User Property: allowMinorUpdates
<allowSnapshots> boolean 1.0-alpha-1 Whether to allow snapshots when searching for the latest version of an artifact.
Default: false
User Property: allowSnapshots
<changeRecorderFormat> String 2.11 The format used to record changes. If "none" is specified, no changes are recorded.
Default: none
User Property: changeRecorderFormat
<changeRecorderOutputFile> File 2.11 The output file used to record changes.
Default: ${project.build.directory}/versions-changes.xml
User Property: changeRecorderOutputFile
<excludeReactor> boolean 1.0-alpha-3 Whether to skip processing dependencies that are produced as part of the current reactor.
Default: true
User Property: excludeReactor
<excludes> String[] 1.0-beta-1 A list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if excludesList is defined.
<excludesList> String 1.0-beta-1 A comma separated list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of excludes from the command line. When specifying excludes from the pom, use the excludes configuration instead. If this property is specified then the excludes configuration is ignored.
User Property: excludes
<forceUpdate> boolean 2.9 to update parent version by force when it is RELEASE or LATEST
Default: false
User Property: forceUpdate
<generateBackupPoms> boolean 1.0-alpha-3 Controls whether a backup pom should be created.
Default: true
User Property: generateBackupPoms
<ignoredVersions> Set<String> 2.13.0

Allows specifying ignored versions directly as an alternative to providing the ruleSet parameter; mainly created for -D property usage.

Example: "1\.0\.1,.+-M.,.*-SNAPSHOT"

Currently, this parameter will override the defined ruleSet


User Property: maven.version.ignore
<includes> String[] 1.0-beta-1 A list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if includesList is defined.
<includesList> String 1.0-beta-1 A comma separated list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of includes from the command line. When specifying includes from the pom, use the includes configuration instead. If this property is specified then the includes configuration is ignored.
User Property: includes
<numThreads> int 2.19.0 Number of executor threads for update retrieval.
Default: 5
User Property: numThreads
<parentVersion> String 1.0-alpha-1

If skipResolution is not set, specifies the bottom version considered for target version resolution. If it is a version range, the resolved version will be restricted by that range.

If skipResolution is true, will specify the target version to which the parent artifact will be updated.


User Property: parentVersion
<ruleSet> RuleSet 2.13.0

Allows specifying the org.codehaus.mojo.versions.model.RuleSet object describing rules on artifact versions to ignore when considering updates.


See also: Using the ruleSet element in the POM
<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: maven.version.rules
<scope> String 2.15 a scope to use to filter the artifacts matching the asked scope (as well as the ones implied by maven)
User Property: scope
<serverId> String 1.0-alpha-3 settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
Default: serverId
User Property: maven.version.rules.serverId
<skipResolution> boolean 2.13.0 Skips version resolution, only valid if parentVersion is set. Will effectively set the new parent version to the one from parentVersion
Default: false
User Property: skipResolution

Parameter Details

<allowDowngrade>

Whether to downgrade a snapshot dependency if allowSnapshots is false and there exists a version within the range fulfilling the criteria.

Default false

  • Type: boolean
  • Since: 2.12.0
  • Required: No
  • User Property: allowDowngrade
  • Default: false

<allowIncrementalUpdates>

Whether to allow the incremental version number to be changed.

Note: false also implies allowMajorUpdates and allowMinorUpdates false

  • Type: boolean
  • Since: 2.13.0
  • Required: No
  • User Property: allowIncrementalUpdates
  • Default: true

<allowMajorUpdates>

Whether to allow the major version number to be changed.
  • Type: boolean
  • Since: 2.13.0
  • Required: No
  • User Property: allowMajorUpdates
  • Default: true

<allowMinorUpdates>

Whether to allow the minor version number to be changed.

Note: false also implies allowMajorUpdates false

  • Type: boolean
  • Since: 2.13.0
  • Required: No
  • User Property: allowMinorUpdates
  • Default: true

<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

<changeRecorderFormat>

The format used to record changes. If "none" is specified, no changes are recorded.
  • Type: java.lang.String
  • Since: 2.11
  • Required: No
  • User Property: changeRecorderFormat
  • Default: none

<changeRecorderOutputFile>

The output file used to record changes.
  • Type: java.io.File
  • Since: 2.11
  • Required: No
  • User Property: changeRecorderOutputFile
  • Default: ${project.build.directory}/versions-changes.xml

<excludeReactor>

Whether to skip processing dependencies that are produced as part of the current reactor.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: excludeReactor
  • Default: true

<excludes>

A list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if excludesList is defined.
  • Type: java.lang.String[]
  • Since: 1.0-beta-1
  • Required: No

<excludesList>

A comma separated list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of excludes from the command line. When specifying excludes from the pom, use the excludes configuration instead. If this property is specified then the excludes configuration is ignored.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • User Property: excludes

<forceUpdate>

to update parent version by force when it is RELEASE or LATEST
  • Type: boolean
  • Since: 2.9
  • Required: No
  • User Property: forceUpdate
  • Default: false

<generateBackupPoms>

Controls whether a backup pom should be created.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: generateBackupPoms
  • Default: true

<ignoredVersions>

Allows specifying ignored versions directly as an alternative to providing the ruleSet parameter; mainly created for -D property usage.

Example: "1\.0\.1,.+-M.,.*-SNAPSHOT"

Currently, this parameter will override the defined ruleSet

  • Type: java.util.Set<java.lang.String>
  • Since: 2.13.0
  • Required: No
  • User Property: maven.version.ignore

<includes>

A list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if includesList is defined.
  • Type: java.lang.String[]
  • Since: 1.0-beta-1
  • Required: No

<includesList>

A comma separated list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifying the set of includes from the command line. When specifying includes from the pom, use the includes configuration instead. If this property is specified then the includes configuration is ignored.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • User Property: includes

<numThreads>

Number of executor threads for update retrieval.
  • Type: int
  • Since: 2.19.0
  • Required: No
  • User Property: numThreads
  • Default: 5

<parentVersion>

If skipResolution is not set, specifies the bottom version considered for target version resolution. If it is a version range, the resolved version will be restricted by that range.

If skipResolution is true, will specify the target version to which the parent artifact will be updated.

  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • User Property: parentVersion

<ruleSet>

Allows specifying the org.codehaus.mojo.versions.model.RuleSet object describing rules on artifact versions to ignore when considering updates.


See also: Using the ruleSet element in the POM
  • Type: org.codehaus.mojo.versions.model.RuleSet
  • Since: 2.13.0
  • Required: No

<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

<scope>

a scope to use to filter the artifacts matching the asked scope (as well as the ones implied by maven)
  • Type: java.lang.String
  • Since: 2.15
  • Required: No
  • User Property: scope

<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

<skipResolution>

Skips version resolution, only valid if parentVersion is set. Will effectively set the new parent version to the one from parentVersion
  • Type: boolean
  • Since: 2.13.0
  • Required: No
  • User Property: skipResolution
  • Default: false