Versions Maven Plugin – versions:display-dependency-updates

versions:display-dependency-updates

Full name:

org.codehaus.mojo:versions-maven-plugin:2.15.0:display-dependency-updates

Description:

Displays all dependencies that have newer versions available. It will also display dependencies which are used by a plugin or defined in the plugin within a pluginManagement.

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
`<allowAnyUpdates>`	`boolean`	`2.5`	Deprecated. Whether to allow any version change to be allowed. This keeps compatibility with previous versions of the plugin. If you set this to false you can control changes in version number by `allowMajorUpdates`, `allowMinorUpdates` or `allowIncrementalUpdates`. Default value is: `true`. User property is: `allowAnyUpdates`.
`<allowIncrementalUpdates>`	`boolean`	`2.5`	Whether to allow the incremental version number to be changed. Note: `false` also implies allowAnyUpdates, allowMajorUpdates, and allowMinorUpdates to be `false` Default value is: `true`. User property is: `allowIncrementalUpdates`.
`<allowMajorUpdates>`	`boolean`	`2.5`	Whether to allow the major version number to be changed. Note: `false` also implies allowAnyUpdates to be `false` Default value is: `true`. User property is: `allowMajorUpdates`.
`<allowMinorUpdates>`	`boolean`	`2.5`	Whether to allow the minor version number to be changed. Note: `false` also implies allowAnyUpdates and allowMajorUpdates to be `false` Default value is: `true`. User property is: `allowMinorUpdates`.
`<allowSnapshots>`	`boolean`	`1.0-alpha-1`	Whether to allow snapshots when searching for the latest version of an artifact. Default value is: `false`. User property is: `allowSnapshots`.
`<changeRecorderFormat>`	`String`	`2.11`	The format used to record changes. If "none" is specified, no changes are recorded. Default value is: `none`. User property is: `changeRecorderFormat`.
`<changeRecorderOutputFile>`	`File`	`2.11`	The output file used to record changes. Default value is: `${project.build.directory}/versions-changes.xml`. User property is: `changeRecorderOutputFile`.
`<dependencyExcludes>`	`List<String>`	`2.12.0`	Exclude these artifacts from consideration. Comma-separated list of extended GAV patterns. Extended GAV: groupId:artifactId:version:type:classifier:scope The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,:::::provided,:::::system"` User property is: `dependencyExcludes`.
`<dependencyIncludes>`	`List<String>`	`2.12.0`	Only take these artifacts into consideration. Comma-separated list of extended GAV patterns. Extended GAV: groupId:artifactId:version:type:classifier:scope The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,:::::compile"` Default value is: ``. User property is: `dependencyIncludes`.
`<dependencyManagementExcludes>`	`List<String>`	`2.12.0`	Exclude these artifacts from consideration. Comma-separated list of extended GAV patterns. Extended GAV: groupId:artifactId:version:type:classifier:scope The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,:::::provided,:::::system"` User property is: `dependencyManagementExcludes`.
`<dependencyManagementIncludes>`	`List<String>`	`2.12.0`	Only take these artifacts into consideration. Comma-separated list of extended GAV patterns. Extended GAV: groupId:artifactId:version:type:classifier:scope The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,:::::compile"` Default value is: ``. User property is: `dependencyManagementIncludes`.
`<generateBackupPoms>`	`boolean`	`1.0-alpha-3`	Controls whether a backup pom should be created. Default value is: `true`. User property is: `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 is: `maven.version.ignore`.
`<logOutput>`	`boolean`	`2.2`	Controls whether the display output is logged to the console. Default value is: `true`. User property is: `versions.logOutput`.
`<outputEncoding>`	`String`	`2.2`	The character encoding to use when writing to `outputFile`. Default value is: `${project.reporting.outputEncoding}`. User property is: `outputEncoding`.
`<outputFile>`	`File`	`2.2`	If specified then the display output will be sent to the specified file. User property is: `versions.outputFile`.
`<outputLineWidth>`	`int`	`2.10.0`	Line width which should be used to format the padding of the version info list output. Default value is: `80`. User property is: `versions.outputLineWidth`.
`<pluginDependencyExcludes>`	`List<String>`	`2.12.0`	Exclude these artifacts into consideration: Comma-separated list of `groupId:[artifactId[:version]]` patterns The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,othergroup:,anothergroup"` User property is*: `pluginDependencyExcludes`.
`<pluginDependencyIncludes>`	`List<String>`	`2.12.0`	Only take these artifacts into consideration: Comma-separated list of `groupId:[artifactId[:version]]` patterns The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,othergroup:,anothergroup"` Default value is: ``. User property is: `pluginDependencyIncludes`.
`<pluginManagementDependencyExcludes>`	`List<String>`	`2.12.0`	Exclude these artifacts into consideration: Comma-separated list of `groupId:[artifactId[:version]]` patterns The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,othergroup:,anothergroup"` User property is*: `pluginManagementDependencyExcludes`.
`<pluginManagementDependencyIncludes>`	`List<String>`	`2.12.0`	Only take these artifacts into consideration: Comma-separated list of `groupId:[artifactId[:version]]` patterns The wildcard "" can be used as the only, first, last or both characters in each token. The version token does support version ranges. Example: `"mygroup:artifact:,othergroup:,anothergroup"` Default value is: ``. User property is: `pluginManagementDependencyIncludes`.
`<processDependencies>`	`boolean`	`1.2`	Whether to process the dependencies section of the project. Default value is: `true`. User property is: `processDependencies`.
`<processDependencyManagement>`	`boolean`	`1.2`	Whether to process the dependencyManagement section of the project. Default value is: `true`. User property is: `processDependencyManagement`.
`<processDependencyManagementTransitive>`	`boolean`	`2.11`	Whether to process the dependencyManagement part transitive or not. In case of `<type>pom</type>`and `<scope>import</scope>` this means by default to report also the imported dependencies. If processTransitive is set to `false` the report will only show updates of the imported pom it self. Default value is: `true`. User property is: `processDependencyManagementTransitive`.
`<processPluginDependencies>`	`boolean`	`2.5`	Whether to process the dependencies sections of plugins. Default value is: `true`. User property is: `processPluginDependencies`.
`<processPluginDependenciesInPluginManagement>`	`boolean`	`2.5`	Whether to process the dependencies sections of plugins which are defined in pluginManagement. Default value is: `true`. User property is: `processPluginDependenciesInPluginManagement`.
`<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 is: `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 value is: `serverId`. User property is: `maven.version.rules.serverId`.
`<verbose>`	`boolean`	`2.1`	Whether to show additional information such as dependencies that do not need updating. Defaults to false. Default value is: `false`. User property is: `verbose`.

Parameter Details

<allowAnyUpdates>

Deprecated. This will be removed with version 3.0.0

Whether to allow any version change to be allowed. This keeps compatibility with previous versions of the plugin. If you set this to false you can control changes in version number by allowMajorUpdates, allowMinorUpdates or allowIncrementalUpdates.

Type: boolean
Since: 2.5
Required: No
User Property: allowAnyUpdates
Default: true

<allowIncrementalUpdates>

Whether to allow the incremental version number to be changed.

Note: false also implies allowAnyUpdates, allowMajorUpdates, and allowMinorUpdates to be false

Type: boolean
Since: 2.5
Required: No
User Property: allowIncrementalUpdates
Default: true

<allowMajorUpdates>

Whether to allow the major version number to be changed.

Note: false also implies allowAnyUpdates to be false

Type: boolean
Since: 2.5
Required: No
User Property: allowMajorUpdates
Default: true

<allowMinorUpdates>

Whether to allow the minor version number to be changed.

Note: false also implies allowAnyUpdates and allowMajorUpdates to be false

Type: boolean
Since: 2.5
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

<dependencyExcludes>

Exclude these artifacts from consideration.

Comma-separated list of extended GAV patterns.

Extended GAV: groupId:artifactId:version:type:classifier:scope

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,*:*:*:*:*:provided,*:*:*:*:*:system"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: dependencyExcludes

<dependencyIncludes>

Only take these artifacts into consideration.

Comma-separated list of extended GAV patterns.

Extended GAV: groupId:artifactId:version:type:classifier:scope

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,*:*:*:*:*:compile"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: dependencyIncludes
Default: *

<dependencyManagementExcludes>

Exclude these artifacts from consideration.

Comma-separated list of extended GAV patterns.

Extended GAV: groupId:artifactId:version:type:classifier:scope

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,*:*:*:*:*:provided,*:*:*:*:*:system"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: dependencyManagementExcludes

<dependencyManagementIncludes>

Only take these artifacts into consideration.

Comma-separated list of extended GAV patterns.

Extended GAV: groupId:artifactId:version:type:classifier:scope

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,*:*:*:*:*:compile"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: dependencyManagementIncludes
Default: *

<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

<pluginDependencyExcludes>

Exclude these artifacts into consideration:
Comma-separated list of groupId:[artifactId[:version]] patterns

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,othergroup:*,anothergroup"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: pluginDependencyExcludes

<pluginDependencyIncludes>

Only take these artifacts into consideration:
Comma-separated list of groupId:[artifactId[:version]] patterns

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,othergroup:*,anothergroup"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: pluginDependencyIncludes
Default: *

<pluginManagementDependencyExcludes>

Exclude these artifacts into consideration:
Comma-separated list of groupId:[artifactId[:version]] patterns

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,othergroup:*,anothergroup"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: pluginManagementDependencyExcludes

<pluginManagementDependencyIncludes>

Only take these artifacts into consideration:
Comma-separated list of groupId:[artifactId[:version]] patterns

The wildcard "*" can be used as the only, first, last or both characters in each token. The version token does support version ranges.

Example: "mygroup:artifact:*,othergroup:*,anothergroup"

Type: java.util.List<java.lang.String>
Since: 2.12.0
Required: No
User Property: pluginManagementDependencyIncludes
Default: *

<processDependencies>

Whether to process the dependencies section of the project.

Type: boolean
Since: 1.2
Required: No
User Property: processDependencies
Default: true

<processDependencyManagement>

Whether to process the dependencyManagement section of the project.

Type: boolean
Since: 1.2
Required: No
User Property: processDependencyManagement
Default: true

<processDependencyManagementTransitive>

Whether to process the dependencyManagement part transitive or not. In case of <type>pom</type>and <scope>import</scope> this means by default to report also the imported dependencies. If processTransitive is set to false the report will only show updates of the imported pom it self.

Type: boolean
Since: 2.11
Required: No
User Property: processDependencyManagementTransitive
Default: true

<processPluginDependencies>

Whether to process the dependencies sections of plugins.

Type: boolean
Since: 2.5
Required: No
User Property: processPluginDependencies
Default: true

<processPluginDependenciesInPluginManagement>

Whether to process the dependencies sections of plugins which are defined in pluginManagement.

Type: boolean
Since: 2.5
Required: No
User Property: processPluginDependenciesInPluginManagement
Default: true

<ruleSet>

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

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

<verbose>

Whether to show additional information such as dependencies that do not need updating. Defaults to false.

Type: boolean
Since: 2.1
Required: No
User Property: verbose
Default: false