versions:display-property-updates
Full name:
org.codehaus.mojo:versions-maven-plugin:2.18.0:display-property-updates
Description:
Displays properties that are linked to artifact versions and have updates available.
Attributes:
- Requires a Maven project to be executed.
- The goal is thread-safe and supports parallel builds.
- Since version:
1.0-beta-1.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<allowIncrementalUpdates> |
boolean |
2.5 |
Whether to allow the incremental version number to be changed. Note: Default: trueUser Property: allowIncrementalUpdates |
<allowMajorUpdates> |
boolean |
2.5 |
Whether to allow the major version number to be changed. Default: trueUser Property: allowMajorUpdates |
<allowMinorUpdates> |
boolean |
2.5 |
Whether to allow the minor version number to be changed. Note: Default: trueUser Property: allowMinorUpdates |
<allowSnapshots> |
boolean |
1.0-alpha-1 |
Whether to allow snapshots when searching for the latest version of an artifact. Default: falseUser Property: allowSnapshots |
<autoLinkItems> |
boolean |
1.0-alpha-2 |
Whether properties linking versions should be auto-detected or not. Default: trueUser Property: autoLinkItems |
<changeRecorderFormat> |
String |
2.11 |
The format used to record changes. If "none" is specified, no changes are recorded. Default: noneUser Property: changeRecorderFormat |
<changeRecorderOutputFile> |
File |
2.11 |
The output file used to record changes. Default: ${project.build.directory}/versions-changes.xmlUser Property: changeRecorderOutputFile |
<excludeProperties> |
String |
1.0-alpha-1 |
A comma separated list of properties to not update. User Property: excludeProperties |
<generateBackupPoms> |
boolean |
1.0-alpha-3 |
Controls whether a backup pom should be created. Default: trueUser Property: 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: maven.version.ignore |
<includeParent> |
boolean |
2.14.0 |
Whether to include property updates from parent. Default: Default: falseUser Property: includeParent |
<includeProperties> |
String |
1.0-alpha-1 |
A comma separated list of properties to update. User Property: includeProperties |
<logOutput> |
boolean |
2.2 |
Controls whether the display output is logged to the console. Default: trueUser Property: versions.logOutput |
<outputEncoding> |
String |
2.2 |
The character encoding to use when writing to outputFile.Default: ${project.reporting.outputEncoding}User Property: outputEncoding |
<outputFile> |
File |
2.2 |
If specified then the display output will be sent to the specified file. User Property: versions.outputFile |
<outputLineWidth> |
int |
2.10.0 |
Line width which should be used to format the padding of the version info list output. Default: 80User Property: versions.outputLineWidth |
<properties> |
Property[] |
1.0-alpha-3 |
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: 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: serverIdUser Property: maven.version.rules.serverId |
Parameter Details
<allowIncrementalUpdates>
Whether to allow the incremental version number to be changed.
Note: false also implies allowMajorUpdates and allowMinorUpdates false
- Type:
boolean - Since:
2.5 - Required:
No - User Property:
allowIncrementalUpdates - Default:
true
<allowMajorUpdates>
Whether to allow the major version number to be changed.
- Type:
boolean - Since:
2.5 - Required:
No - User Property:
allowMajorUpdates - Default:
true
<allowMinorUpdates>
Whether to allow the minor version number to be changed.
Note: false also implies allowMajorUpdates false
- Type:
boolean - Since:
2.5 - Required:
No - User Property:
allowMinorUpdates - Default:
true
<allowSnapshots>
Whether to allow snapshots when searching for the latest version of an artifact.
- Type:
boolean - Since:
1.0-alpha-1 - Required:
No - User Property:
allowSnapshots - Default:
false
<autoLinkItems>
Whether properties linking versions should be auto-detected or not.
- Type:
boolean - Since:
1.0-alpha-2 - Required:
No - User Property:
autoLinkItems - Default:
true
<changeRecorderFormat>
The format used to record changes. If "none" is specified, no changes are recorded.
- Type:
java.lang.String - Since:
2.11 - Required:
No - User Property:
changeRecorderFormat - Default:
none
<changeRecorderOutputFile>
The output file used to record changes.
- Type:
java.io.File - Since:
2.11 - Required:
No - User Property:
changeRecorderOutputFile - Default:
${project.build.directory}/versions-changes.xml
<excludeProperties>
A comma separated list of properties to not update.
- Type:
java.lang.String - Since:
1.0-alpha-1 - Required:
No - User Property:
excludeProperties
<generateBackupPoms>
Controls whether a backup pom should be created.
- 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
<includeParent>
Whether to include property updates from parent. Default: false
- Type:
boolean - Since:
2.14.0 - Required:
No - User Property:
includeParent - Default:
false
<includeProperties>
A comma separated list of properties to update.
- Type:
java.lang.String - Since:
1.0-alpha-1 - Required:
No - User Property:
includeProperties
<logOutput>
Controls whether the display output is logged to the console.
- Type:
boolean - Since:
2.2 - Required:
No - User Property:
versions.logOutput - Default:
true
<outputEncoding>
The character encoding to use when writing to
outputFile.- Type:
java.lang.String - Since:
2.2 - Required:
No - User Property:
outputEncoding - Default:
${project.reporting.outputEncoding}
<outputFile>
If specified then the display output will be sent to the specified file.
- Type:
java.io.File - Since:
2.2 - Required:
No - User Property:
versions.outputFile
<outputLineWidth>
Line width which should be used to format the padding of the version info list output.
- Type:
int - Since:
2.10.0 - Required:
No - User Property:
versions.outputLineWidth - Default:
80
<properties>
Any restrictions that apply to specific properties.
- Type:
org.codehaus.mojo.versions.api.Property[] - Since:
1.0-alpha-3 - 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