Fork me on GitHub

versions:property-updates-report

Note:This goal should be used as a Maven report.

Full name:

org.codehaus.mojo:versions-maven-plugin:2.4:property-updates-report

Description:

Generates a report of available updates for properties of a project which are linked to the dependencies and/or plugins of a project.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Since version: 1.0-beta-1.

Required Parameters

Name Type Since Description
outputDirectory File 1.0-alpha-3 The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
Default value is: ${project.reporting.outputDirectory}.

Optional Parameters

Name Type Since Description
allowSnapshots boolean 1.0-alpha-3 Whether to allow snapshots when searching for the latest version of an artifact.
Default value is: false.
User property is: allowSnapshots.
autoLinkItems boolean 1.0-beta-1 Whether properties linking versions should be auto-detected or not.
Default value is: true.
User property is: autoLinkItems.
comparisonMethod String 1.0-alpha-1 The versioning rule to use when comparing versions. Valid values are maven, numeric which will handle long version numbers provided all components are numeric, or mercury which will use the mercury version number comparison rules.
User property is: comparisonMethod.
excludeProperties String 1.0-beta-1 A comma separated list of properties to not include in the report.
User property is: excludeProperties.
includeProperties String 1.0-beta-1 A comma separated list of properties to include in the report.
User property is: includeProperties.
properties Property[] 1.0-beta-1 Any restrictions that apply to specific properties.
rulesUri String 1.0-alpha-3 The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
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.
skip boolean 1.0-alpha-3 Skip entire check.
User property is: versions.skip.

Parameter Details

allowSnapshots:

Whether to allow snapshots when searching for the latest version of an artifact.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: allowSnapshots
  • Default: false

autoLinkItems:

Whether properties linking versions should be auto-detected or not.
  • Type: boolean
  • Since: 1.0-beta-1
  • Required: No
  • User Property: autoLinkItems
  • Default: true

comparisonMethod:

The versioning rule to use when comparing versions. Valid values are maven, numeric which will handle long version numbers provided all components are numeric, or mercury which will use the mercury version number comparison rules.
  • Type: java.lang.String
  • Since: 1.0-alpha-1
  • Required: No
  • User Property: comparisonMethod

excludeProperties:

A comma separated list of properties to not include in the report.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • User Property: excludeProperties

includeProperties:

A comma separated list of properties to include in the report.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • User Property: includeProperties

outputDirectory:

The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from the command line. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.
  • Type: java.io.File
  • Since: 1.0-alpha-3
  • Required: Yes
  • Default: ${project.reporting.outputDirectory}

properties:

Any restrictions that apply to specific properties.
  • Type: org.codehaus.mojo.versions.Property[]
  • Since: 1.0-beta-1
  • Required: No

rulesUri:

The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
  • 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

skip:

Skip entire check.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: versions.skip