Fork me on GitHub
Built by Maven

versions:display-extension-updates

Full name:

org.codehaus.mojo:versions-maven-plugin:2.16.2:display-extension-updates

Description:

Displays all build and core extensions that have newer versions available.

Attributes:

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

Optional Parameters

Name Type Since Description
<allowIncrementalUpdates> boolean 2.15.0

Whether to allow the incremental version number to be changed.

Note: false also implies allowMajorUpdates and allowMinorUpdates to be false


Default value is: true.
User property is: allowIncrementalUpdates.
<allowMajorUpdates> boolean 2.15.0 Whether to allow the major version number to be changed.
Default value is: true.
User property is: allowMajorUpdates.
<allowMinorUpdates> boolean 2.15.0

Whether to allow the minor version number to be changed.

Note: false also implies 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.
<extensionExcludes> List<String> 2.15.0

Specifies a comma-separated list of GAV patterns to NOT consider when looking for updates. If the trailing parts of the GAV are omitted, then can assume any value.

This list is taken into account after extensionIncludes

.

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

Examples: "mygroup:artifact:*", "mygroup:artifact", "mygroup"
User property is: extensionExcludes.
<extensionIncludes> List<String> 2.15.0

Specifies a comma-separated list of GAV patterns to consider when looking for updates. If the trailing parts of the GAV are omitted, then can assume any value.

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

Examples: "mygroup:artifact:*", "mygroup:artifact", "mygroup"
Default value is: *.
User property is: extensionIncludes.
<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.
<interpolateProperties> boolean 2.15.0 If set to false, the plugin will not interpolate property values when looking for versions to be changed, but will instead operate on raw model.
Default value is: true.
User property is: interpolateProperties.
<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.
<processBuildExtensions> boolean 2.15.0

Whether to process build extensions. Default is true.


Default value is: true.
User property is: processBuildExtensions.
<processCoreExtensions> boolean 2.15.0

Whether to process core extensions. Default is true.


Default value is: true.
User property is: processCoreExtensions.
<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.15.0 Whether to show additional information such as extensions that do not need updating. Defaults to false.
Default value is: false.
User property is: verbose.

Parameter Details

<allowIncrementalUpdates>

Whether to allow the incremental version number to be changed.

Note: false also implies allowMajorUpdates and allowMinorUpdates to be false

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

<allowMajorUpdates>

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

<allowMinorUpdates>

Whether to allow the minor version number to be changed.

Note: false also implies allowMajorUpdates to be false

  • Type: boolean
  • Since: 2.15.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

<extensionExcludes>

Specifies a comma-separated list of GAV patterns to NOT consider when looking for updates. If the trailing parts of the GAV are omitted, then can assume any value.

This list is taken into account after extensionIncludes

.

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

Examples: "mygroup:artifact:*", "mygroup:artifact", "mygroup"
  • Type: java.util.List<java.lang.String>
  • Since: 2.15.0
  • Required: No
  • User Property: extensionExcludes

<extensionIncludes>

Specifies a comma-separated list of GAV patterns to consider when looking for updates. If the trailing parts of the GAV are omitted, then can assume any value.

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

Examples: "mygroup:artifact:*", "mygroup:artifact", "mygroup"
  • Type: java.util.List<java.lang.String>
  • Since: 2.15.0
  • Required: No
  • User Property: extensionIncludes
  • 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

<interpolateProperties>

If set to false, the plugin will not interpolate property values when looking for versions to be changed, but will instead operate on raw model.
  • Type: boolean
  • Since: 2.15.0
  • Required: No
  • User Property: interpolateProperties
  • Default: true

<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

<processBuildExtensions>

Whether to process build extensions. Default is true.

  • Type: boolean
  • Since: 2.15.0
  • Required: No
  • User Property: processBuildExtensions
  • Default: true

<processCoreExtensions>

Whether to process core extensions. Default is true.

  • Type: boolean
  • Since: 2.15.0
  • Required: No
  • User Property: processCoreExtensions
  • Default: true

<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

<verbose>

Whether to show additional information such as extensions that do not need updating. Defaults to false.
  • Type: boolean
  • Since: 2.15.0
  • Required: No
  • User Property: verbose
  • Default: false