versions:plugin-updates-report

Note:

This goal should be used as a Maven report.

Full name:

org.codehaus.mojo:versions-maven-plugin:2.18.0:plugin-updates-report

Description:

Generates a report of available updates for the plugins of a project.

Attributes:

Requires a Maven project to be executed.
Requires dependency resolution of artifacts in scope: runtime.
The goal is thread-safe and supports parallel builds.
Since version: 1.0-beta-1.

Required Parameters

Name	Type	Since	Description
`<outputDirectory>`	`File`	`-`	The shared 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 shared output directory configured in the Maven Site Plugin is used instead. A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by `#getOutputName()`. Default: `${project.build.directory}/reports`

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: `false` User Property: `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: `comparisonMethod`
`<formats>`	`String[]`	`-`	Report formats (html and/or xml). HTML by default. Default: `html` User Property: `pluginUpdatesReportFormats`
`<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: `maven.version.ignore`
`<locale>`	`String`	`-`	The locale to use when the report generation is invoked directly as a standalone Mojo. See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String) Default: `default`
`<onlyProjectPlugins>`	`boolean`	`2.12`	If `true`, only shows the subsection of the `pluginManagement` artifacts that are actually used in the project's `plugin` graph. `false` by default. Default: `false` User Property: `onlyProjectPlugins`
`<onlyUpgradable>`	`boolean`	`2.12`	If `true`, only shows upgradable plugins in the report. `false` by default. Default: `false` User Property: `onlyUpgradable`
`<outputFormat>`	`String`	`-`	The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id. User Property: `output.format`
`<outputTimestamp>`	`String`	`-`	Timestamp for reproducible output archive entries, either formatted as ISO 8601 `yyyy-MM-dd'T'HH:mm:ssXXX` or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH). Default: `${project.build.outputTimestamp}`
`<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: `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: `serverId` User Property: `maven.version.rules.serverId`
`<siteDirectory>`	`File`	`-`	Directory containing the `site.xml` file. Default: `${basedir}/src/site`
`<skip>`	`boolean`	`1.0-alpha-3`	Skip entire check. User Property: `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: pluginUpdatesReportFormats
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

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: SiteTool#DEFAULT_LOCALE, SiteTool#getSiteLocales(String)

Type: java.lang.String
Required: No
Default: default

<onlyProjectPlugins>

If true, only shows the subsection of the pluginManagement artifacts that are actually used in the project's plugin graph. false by default.

Type: boolean
Since: 2.12
Required: No
User Property: onlyProjectPlugins
Default: false

<onlyUpgradable>

If true, only shows upgradable plugins in the report. false by default.

Type: boolean
Since: 2.12
Required: No
User Property: onlyUpgradable
Default: false

<outputDirectory>

The shared 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 shared output directory configured in the Maven Site Plugin is used instead.

A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the main output file (entry point) denoted by #getOutputName().

Type: java.io.File
Required: Yes
Default: ${project.build.directory}/reports

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.

Type: java.lang.String
Required: No
User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

Type: java.lang.String
Required: No
Default: ${project.build.outputTimestamp}

<ruleSet>

Allows specifying the org.codehaus.mojo.versions.model.RuleSet object describing rules on artifact versions to ignore when considering updates.

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

<siteDirectory>

Directory containing the site.xml file.

Type: java.io.File
Required: No
Default: ${basedir}/src/site

<skip>

Skip entire check.

Type: boolean
Since: 1.0-alpha-3
Required: No
User Property: versions.skip