Fork me on GitHub
Built by Maven

versions:property-updates-aggregate-report

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

Full name:

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

Description:

Generates an aggregate 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.
  • 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.
<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.
<formats> String[] 2.14.0 Report formats (html and/or xml). HTML by default.
Default value is: html.
User property is: propertyUpdatesReportFormats.
<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.
<includeParent> boolean 2.14.0

Whether to include property updates from parent.


Default value is: true.
User property is: includeParent.
<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.
<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

<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

<formats>

Report formats (html and/or xml). HTML by default.
  • Type: java.lang.String[]
  • Since: 2.14.0
  • Required: No
  • User Property: propertyUpdatesReportFormats
  • 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

<includeParent>

Whether to include property updates from parent.

  • Type: boolean
  • Since: 2.14.0
  • Required: No
  • User Property: includeParent
  • Default: true

<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

<properties>

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

<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