Fork me on GitHub

versions:display-property-updates

Full name:

org.codehaus.mojo:versions-maven-plugin:2.8.1:display-property-updates

Description:

Displays properties that are linked to artifact versions and have updates available.

Attributes:

  • Requires a Maven project to be executed.
  • Executes by direct invocation only.
  • 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.
Default value is: true.
User property is: allowIncrementalUpdates.
<allowMajorUpdates> boolean 2.5 Whether to allow the major version number to be changed.
Default value is: true.
User property is: allowMajorUpdates.
<allowMinorUpdates> boolean 2.5 Whether to allow the minor version number to be changed.
Default value is: true.
User property is: allowMinorUpdates.
<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.
<autoLinkItems> boolean 1.0-alpha-2 Whether properties linking versions should be auto-detected or not.
Default value is: true.
User property is: autoLinkItems.
<excludeProperties> String 1.0-alpha-1 A comma separated list of properties to not update.
User property is: excludeProperties.
<generateBackupPoms> boolean 1.0-alpha-3 Controls whether a backup pom should be created.
Default value is: true.
User property is: generateBackupPoms.
<includeProperties> String 1.0-alpha-1 A comma separated list of properties to update.
User property is: includeProperties.
<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.
<properties> Property[] 1.0-alpha-3 Any restrictions that apply to specific properties.
<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

<allowIncrementalUpdates>

Whether to allow the incremental version number to be changed.
  • 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.
  • 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

<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

<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

<properties>

Any restrictions that apply to specific properties.
  • Type: org.codehaus.mojo.versions.Property[]
  • Since: 1.0-alpha-3
  • 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