versions:display-plugin-updates
Full name:
org.codehaus.mojo:versions-maven-plugin:2.16.2:display-plugin-updates
Description:
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Since version:
1.0-alpha-1
.
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<allowSnapshots> |
boolean |
1.0-alpha-1 |
Whether to allow snapshots when searching for the latest version of an artifact. Default value is: false .User property is: allowSnapshots . |
<changeRecorderFormat> |
String |
2.11 |
The format used to record changes. If "none" is specified, no changes are recorded. Default value is: none .User property is: changeRecorderFormat . |
<changeRecorderOutputFile> |
File |
2.11 |
The output file used to record changes. Default value is: ${project.build.directory}/versions-changes.xml .User property is: changeRecorderOutputFile . |
<generateBackupPoms> |
boolean |
1.0-alpha-3 |
Controls whether a backup pom should be created. Default value is: true .User property is: generateBackupPoms . |
<ignoredVersions> |
Set<String> |
2.13.0 |
Allows specifying ignored versions directly as an alternative to providing the ruleSet parameter; mainly created for Example: Currently, this parameter will override the defined User property is: maven.version.ignore . |
<logOutput> |
boolean |
2.2 |
Controls whether the display output is logged to the console. Default value is: true .User property is: versions.logOutput . |
<outputEncoding> |
String |
2.2 |
The character encoding to use when writing to outputFile .Default value is: ${project.reporting.outputEncoding} .User property is: outputEncoding . |
<outputFile> |
File |
2.2 |
If specified then the display output will be sent to the specified file. User property is: versions.outputFile . |
<outputLineWidth> |
int |
2.10.0 |
Line width which should be used to format the padding of the version info list output. Default value is: 80 .User property is: versions.outputLineWidth . |
<processUnboundPlugins> |
boolean |
2.15.0 |
If set to It might not always be possible to update these plugins, thus the default value of this parameter is Default value is: false .User property is: processUnboundPlugins . |
<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 . |
Parameter Details
<allowSnapshots>
- Type:
boolean
- Since:
1.0-alpha-1
- Required:
No
- User Property:
allowSnapshots
- Default:
false
<changeRecorderFormat>
- Type:
java.lang.String
- Since:
2.11
- Required:
No
- User Property:
changeRecorderFormat
- Default:
none
<changeRecorderOutputFile>
- Type:
java.io.File
- Since:
2.11
- Required:
No
- User Property:
changeRecorderOutputFile
- Default:
${project.build.directory}/versions-changes.xml
<generateBackupPoms>
- Type:
boolean
- Since:
1.0-alpha-3
- Required:
No
- User Property:
generateBackupPoms
- Default:
true
<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
<logOutput>
- Type:
boolean
- Since:
2.2
- Required:
No
- User Property:
versions.logOutput
- Default:
true
<outputEncoding>
outputFile
.- Type:
java.lang.String
- Since:
2.2
- Required:
No
- User Property:
outputEncoding
- Default:
${project.reporting.outputEncoding}
<outputFile>
- Type:
java.io.File
- Since:
2.2
- Required:
No
- User Property:
versions.outputFile
<outputLineWidth>
- Type:
int
- Since:
2.10.0
- Required:
No
- User Property:
versions.outputLineWidth
- Default:
80
<processUnboundPlugins>
If set to true
, will also display updates to plugins where no version is specified in the current POM, but whose version is specified in the parent or the "superpom".
It might not always be possible to update these plugins, thus the default value of this parameter is false
- Type:
boolean
- Since:
2.15.0
- Required:
No
- User Property:
processUnboundPlugins
- Default:
false
<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>
classpath:///package/sub/package/rules.xml
).- Type:
java.lang.String
- Since:
1.0-alpha-3
- Required:
No
- User Property:
maven.version.rules
<serverId>
- Type:
java.lang.String
- Since:
1.0-alpha-3
- Required:
No
- User Property:
maven.version.rules.serverId
- Default:
serverId