Fork me on GitHub
Built by Maven

versions:display-parent-updates

Full name:

org.codehaus.mojo:versions-maven-plugin:2.19.1:display-parent-updates

Description:

Displays any updates of the project's parent project

Attributes:

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

Optional Parameters

Name Type Since Description
<allowDowngrade> boolean 2.16.2

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.16.2

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.16.2 Whether to allow the major version number to be changed.
Default: true
User Property: allowMajorUpdates
<allowMinorUpdates> boolean 2.16.2

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
<forceUpdate> boolean 2.16.2 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
<logOutput> boolean 2.2 Controls whether the display output is logged to the console.
Default: true
User Property: versions.logOutput
<outputEncoding> String 2.2 The character encoding to use when writing to outputFile.
Default: ${project.reporting.outputEncoding}
User Property: outputEncoding
<outputFile> File 2.2 If specified then the display output will be sent to the specified file.
User Property: versions.outputFile
<outputLineWidth> int 2.10.0 Line width which should be used to format the padding of the version info list output.
Default: 80
User Property: versions.outputLineWidth
<parentVersion> String 2.16.2

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
<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.16.2 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.16.2
  • 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.16.2
  • Required: No
  • User Property: allowIncrementalUpdates
  • Default: true

<allowMajorUpdates>

Whether to allow the major version number to be changed.
  • Type: boolean
  • Since: 2.16.2
  • 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.16.2
  • 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

<forceUpdate>

to update parent version by force when it is RELEASE or LATEST
  • Type: boolean
  • Since: 2.16.2
  • 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

<logOutput>

Controls whether the display output is logged to the console.
  • Type: boolean
  • Since: 2.2
  • Required: No
  • User Property: versions.logOutput
  • Default: true

<outputEncoding>

The character encoding to use when writing to outputFile.
  • Type: java.lang.String
  • Since: 2.2
  • Required: No
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

<outputFile>

If specified then the display output will be sent to the specified file.
  • Type: java.io.File
  • Since: 2.2
  • Required: No
  • User Property: versions.outputFile

<outputLineWidth>

Line width which should be used to format the padding of the version info list output.
  • Type: int
  • Since: 2.10.0
  • Required: No
  • User Property: versions.outputLineWidth
  • Default: 80

<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: 2.16.2
  • 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

<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.16.2
  • Required: No
  • User Property: skipResolution
  • Default: false