versions:compare-dependencies

Full name:

org.codehaus.mojo:versions-maven-plugin:1.3.1:compare-dependencies

Description:

Compare dependency versions of the current project to dependencies or dependency management of a remote repository project.

Attributes:

  • Requires a Maven project to be executed.
  • Executes by direct invocation only.
  • Since version: 1.3.

Required Parameters

Name Type Since Description
remotePom String 1.3 The groupId, artifactId, and version of the remote project (POM) to which we are comparing. This should be in the form "groupId:artifactId:version"

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.
excludeReactor Boolean 1.0-alpha-3 Whether to skip processing dependencies that are produced as part of the current reactor.
excludes String[] 1.0-beta-1 A list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if excludesList is defined.
excludesList String 1.0-beta-1 A comma separated list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifing the set of excludes from the command line. When specifying excludes from the pom, use the excludes configuration instead. If this property is specified then the exclude configuration is ignored.
generateBackupPoms Boolean 1.0-alpha-3 Controls whether a backup pom should be created (default is true).
ignoreRemoteDependencies boolean 1.3 Ignore the list of remote dependencies and only compare the remote dependencyManagement
ignoreRemoteDependencyManagement boolean 1.3 Ignore the remote dependency management and only check against the actual dependencies of the remote project
Default value is: false.
includes String[] 1.0-beta-1 A list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if includesList is defined.
includesList String 1.0-beta-1 A comma separated list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifing the set of includes from the command line. When specifying includes from the pom, use the includes configuration instead. If this property is specified then the include configuration is ignored.
processDependencies Boolean 1.0-alpha-3 Whether to process the dependencies section of the project. If not set will default to true.
processDependencyManagement Boolean 1.0-alpha-3 Whether to process the dependencyManagement section of the project. If not set will default to true.
reportMode boolean 1.3 Display the dependency version differences on the command line, but do not update the versions in the current pom. If updateDependencies is set to "true" this will automatically be set to false.
Default value is: true.
reportOutputFile File 1.3 If the output file is set, the diff report will be written to this file.
Default value is: null.
rulesUri String 1.0-alpha-3 The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
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.
updateDependencies boolean 1.3 Update dependency versions in the current POM.
Default value is: false.
updatePropertyVersions boolean 1.3 Update dependency versions stored in properties
Default value is: false.

Parameter Details

allowSnapshots:

Whether to allow snapshots when searching for the latest version of an artifact.
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-1
  • Required: No
  • Expression: ${allowSnapshots}
  • Default: false

excludeReactor:

Whether to skip processing dependencies that are produced as part of the current reactor.
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${excludeReactor}

excludes:

A list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if excludesList is defined.
  • Type: java.lang.String[]
  • Since: 1.0-beta-1
  • Required: No

excludesList:

A comma separated list of artifact patterns to exclude. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifing the set of excludes from the command line. When specifying excludes from the pom, use the excludes configuration instead. If this property is specified then the exclude configuration is ignored.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${excludes}

generateBackupPoms:

Controls whether a backup pom should be created (default is true).
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${generateBackupPoms}

ignoreRemoteDependencies:

Ignore the list of remote dependencies and only compare the remote dependencyManagement
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Expression: ${ignoreRemoteDependencies}

ignoreRemoteDependencyManagement:

Ignore the remote dependency management and only check against the actual dependencies of the remote project
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Expression: ${ignoreRemoteDependencyManagement}
  • Default: false

includes:

A list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". This configuration setting is ignored if includesList is defined.
  • Type: java.lang.String[]
  • Since: 1.0-beta-1
  • Required: No

includesList:

A comma separated list of artifact patterns to include. Follows the pattern "groupId:artifactId:type:classifier:version". Designed to allow specifing the set of includes from the command line. When specifying includes from the pom, use the includes configuration instead. If this property is specified then the include configuration is ignored.
  • Type: java.lang.String
  • Since: 1.0-beta-1
  • Required: No
  • Expression: ${includes}

processDependencies:

Whether to process the dependencies section of the project. If not set will default to true.
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${processDependencies}

processDependencyManagement:

Whether to process the dependencyManagement section of the project. If not set will default to true.
  • Type: java.lang.Boolean
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${processDependencyManagement}

remotePom:

The groupId, artifactId, and version of the remote project (POM) to which we are comparing. This should be in the form "groupId:artifactId:version"
  • Type: java.lang.String
  • Since: 1.3
  • Required: Yes
  • Expression: ${remotePom}

reportMode:

Display the dependency version differences on the command line, but do not update the versions in the current pom. If updateDependencies is set to "true" this will automatically be set to false.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Expression: ${reportMode}
  • Default: true

reportOutputFile:

If the output file is set, the diff report will be written to this file.
  • Type: java.io.File
  • Since: 1.3
  • Required: No
  • Expression: ${reportOutputFile}
  • Default: null

rulesUri:

The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
  • Type: java.lang.String
  • Since: 1.0-alpha-3
  • Required: No
  • Expression: ${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
  • Expression: ${maven.version.rules.serverId}
  • Default: serverId

updateDependencies:

Update dependency versions in the current POM.
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Expression: ${updateDependencies}
  • Default: false

updatePropertyVersions:

Update dependency versions stored in properties
  • Type: boolean
  • Since: 1.3
  • Required: No
  • Expression: ${updatePropertyVersions}
  • Default: false