Fork me on GitHub
Built by Maven

versions:dependency-updates-aggregate-report

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

Full name:

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

Description:

Generates an aggregate report of available updates for the dependencies of a project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.14.0.

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[] - Report formats (html and/or xml). HTML by default.
Default value is: html.
User property is: dependencyUpdatesReportFormats.
<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.
<onlyProjectDependencies> boolean 2.12 If true, only shows the subsection of the dependencyManagement artifacts that are actually used in the project's dependency graph. false by default.
Default value is: false.
User property is: onlyProjectDependencies.
<onlyUpgradable> boolean 2.12 If true, only shows upgradable dependencies in the report. false by default.
Default value is: false.
User property is: onlyUpgradable.
<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 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 itself.
Default value is: true.
User property is: processDependencyManagementTransitive.
<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.
<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[]
  • Required: No
  • User Property: dependencyUpdatesReportFormats
  • Default: html

<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

<onlyProjectDependencies>

If true, only shows the subsection of the dependencyManagement artifacts that are actually used in the project's dependency graph. false by default.
  • Type: boolean
  • Since: 2.12
  • Required: No
  • User Property: onlyProjectDependencies
  • Default: false

<onlyUpgradable>

If true, only shows upgradable dependencies in the report. false by default.
  • Type: boolean
  • Since: 2.12
  • Required: No
  • User Property: onlyUpgradable
  • Default: false

<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 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 itself.
  • Type: boolean
  • Since: 2.5 Note: Currently in experimental state.
  • Required: No
  • User Property: processDependencyManagementTransitive
  • 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

<skip>

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