versions:dependency-updates-report

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

Full name:

org.codehaus.mojo:versions-maven-plugin:2.0:dependency-updates-report

Description:

Generates a report of available updates for the dependencies 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.
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.
rulesUri String 1.0-alpha-3 The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
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.
skip Boolean 1.0-alpha-3 Skip entire check.

Parameter Details

allowSnapshots:

Whether to allow snapshots when searching for the latest version of an artifact.
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${allowSnapshots}
  • Default: false

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
  • Expression: ${comparisonMethod}

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}

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
  • Expression: ${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
  • Expression: ${maven.version.rules.serverId}
  • Default: serverId

skip:

Skip entire check.
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${versions.skip}