versions:update-child-modules

Full name:

org.codehaus.mojo:versions-maven-plugin:2.25.2:update-child-modules

Description:

Scans the current projects child modules, updating the versions of any which use the current project to the version of the current project.

Attributes:

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

Optional Parameters

Name Type Since Description
<allowPreReleases> boolean 2.25.0 (2.20.0 for <code>use-latest-versions</code>) Whether to offer pre-release versions: alpha, beta, milestone, release candidate, preview and early-access versions, such as 4.0.0-beta-4 or 3.34.0.CR1. When false, a pre-release is still offered if the current version is itself a pre-release or a snapshot of the same release line, so 4.0.0-beta-3 is offered 4.0.0-beta-4 but not 4.1.0-M1. Snapshots are governed by allowSnapshots, and ignoredVersions and rules still apply on top.
Default: false
User Property: allowPreReleases
<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
<dependabotConfig> String 2.25.0

A Dependabot configuration file whose ignore entries are applied as version rules, on top of ruleSet, rulesUri and ignoredVersions.

Only the package-ecosystem: maven entries for dependabotTargetBranch are read. Each versions item may be a Maven version range, a comparator requirement such as ">= 5.0.0", or a single version. Items that only use update-types are skipped with a warning. A relative path is resolved against the multi-module project directory.

Example: -Dversions.dependabotConfig=.github/dependabot.yml


User Property: versions.dependabotConfig
<dependabotTargetBranch> String 2.25.0

The target-branch whose entries in dependabotConfig apply. Defaults to the branch checked out in the git working tree holding that file; the entries without a target-branch are used when no entry names the branch.


User Property: versions.dependabotTargetBranch
<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
<minimumReleaseAge> int 2.25.0 Minimum number of days a release must have been published before it is offered as an update. This keeps a very recent release, which may be faulty or compromised, out of the update candidates; Renovate calls the same idea minimumReleaseAge, and Dependabot calls it cooldown.
A version older than or equal to the current one is not affected. The publication date is read through Maven's own transport, so the proxy, mirror and server settings apply. If the date cannot be determined, the version is offered and a warning says so. 0, the default, switches the filter off.
Default: 0
User Property: versions.minimumReleaseAge
<minimumReleaseAgeExcludes> String[] 2.25.0 groupId:artifactId patterns of the artifacts that are exempt from minimumReleaseAge, for artifacts whose sources you trust. * matches any run of characters, and an artifactId may be left out to match the whole group, for example com.example:* or com.example.
On the command line, separate the patterns with commas.
User Property: versions.minimumReleaseAgeExcludes
<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 URI served by a Maven Resolver transport (e.g. file: or https:) or a classpath URI (e.g. classpath:///package/sub/package/rules.xml).
User Property: maven.version.rules
<serverId> String 1.0-alpha-3 settings.xml's server id for the URL. This is used when the server hosting the rules needs authentication.
Default: serverId
User Property: maven.version.rules.serverId
<skip> boolean 2.21.0 If true, the plugin execution will be skipped.
Default: false
User Property: versions.skip

Parameter Details

<allowPreReleases>

Whether to offer pre-release versions: alpha, beta, milestone, release candidate, preview and early-access versions, such as 4.0.0-beta-4 or 3.34.0.CR1. When false, a pre-release is still offered if the current version is itself a pre-release or a snapshot of the same release line, so 4.0.0-beta-3 is offered 4.0.0-beta-4 but not 4.1.0-M1. Snapshots are governed by allowSnapshots, and ignoredVersions and rules still apply on top.
  • Type: boolean
  • Since: 2.25.0 (2.20.0 for <code>use-latest-versions</code>)
  • Required: No
  • User Property: allowPreReleases
  • Default: false

<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

<dependabotConfig>

A Dependabot configuration file whose ignore entries are applied as version rules, on top of ruleSet, rulesUri and ignoredVersions.

Only the package-ecosystem: maven entries for dependabotTargetBranch are read. Each versions item may be a Maven version range, a comparator requirement such as ">= 5.0.0", or a single version. Items that only use update-types are skipped with a warning. A relative path is resolved against the multi-module project directory.

Example: -Dversions.dependabotConfig=.github/dependabot.yml

  • Type: java.lang.String
  • Since: 2.25.0
  • Required: No
  • User Property: versions.dependabotConfig

<dependabotTargetBranch>

The target-branch whose entries in dependabotConfig apply. Defaults to the branch checked out in the git working tree holding that file; the entries without a target-branch are used when no entry names the branch.

  • Type: java.lang.String
  • Since: 2.25.0
  • Required: No
  • User Property: versions.dependabotTargetBranch

<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

<minimumReleaseAge>

Minimum number of days a release must have been published before it is offered as an update. This keeps a very recent release, which may be faulty or compromised, out of the update candidates; Renovate calls the same idea minimumReleaseAge, and Dependabot calls it cooldown.
A version older than or equal to the current one is not affected. The publication date is read through Maven's own transport, so the proxy, mirror and server settings apply. If the date cannot be determined, the version is offered and a warning says so. 0, the default, switches the filter off.
  • Type: int
  • Since: 2.25.0
  • Required: No
  • User Property: versions.minimumReleaseAge
  • Default: 0

<minimumReleaseAgeExcludes>

groupId:artifactId patterns of the artifacts that are exempt from minimumReleaseAge, for artifacts whose sources you trust. * matches any run of characters, and an artifactId may be left out to match the whole group, for example com.example:* or com.example.
On the command line, separate the patterns with commas.
  • Type: java.lang.String[]
  • Since: 2.25.0
  • Required: No
  • User Property: versions.minimumReleaseAgeExcludes

<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 URI served by a Maven Resolver transport (e.g. file: or https:) 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 the server hosting the rules needs authentication.
  • Type: java.lang.String
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: maven.version.rules.serverId
  • Default: serverId

<skip>

If true, the plugin execution will be skipped.
  • Type: boolean
  • Since: 2.21.0
  • Required: No
  • User Property: versions.skip
  • Default: false