Fork me on GitHub

versions:dependency-updates-report

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

Full name:

org.codehaus.mojo:versions-maven-plugin:2.8.1: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.
User property is: allowSnapshots.
<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.
<formats> String[] 1.0-beta-1 Report formats (html and/or xml). HTML by default.
Default value is: html.
User property is: dependencyUpdatesReportFormats.
<processDependencyManagement> boolean 2.5 Whether to process the dependencyManagement in pom or not.
Default value is: true.
User property is: processDependencyManagement.
<processDependencyManagementTransitive> boolean 2.5 Note: Currently in experimental state. Whether to process the depdendencyManagement 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.
<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.
<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

<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

<formats>

Report formats (html and/or xml). HTML by default.
  • Type: java.lang.String[]
  • Since: 1.0-beta-1
  • Required: No
  • User Property: dependencyUpdatesReportFormats
  • Default: html

<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}

<processDependencyManagement>

Whether to process the dependencyManagement in pom or not.
  • Type: boolean
  • Since: 2.5
  • Required: No
  • User Property: processDependencyManagement
  • Default: true

<processDependencyManagementTransitive>

Whether to process the depdendencyManagement 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.5 Note: Currently in experimental state.
  • Required: No
  • User Property: processDependencyManagementTransitive
  • Default: true

<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

<skip>

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