Fork me on GitHub
Built by Maven

versions:use-dep-version

Full name:

org.codehaus.mojo:versions-maven-plugin:2.13.0:use-dep-version

Description:

Updates a dependency to a specific version. This can be useful if you have to manage versions for a very large (100+ module) projects where you can't always use the most up-to-date version of a particular third party component.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.3.

Required Parameters

Name Type Since Description
<depVersion> String 2.3 The exact version to be applied for the included dependencies
User property is: depVersion.

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.
<excludeReactor> boolean 1.0-alpha-3 Whether to skip processing dependencies that are produced as part of the current reactor.
Default value is: true.
User property is: excludeReactor.
<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 specifying 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.
User property is: excludes.
<forceVersion> boolean 2.3 If set to true, will use whatever version is supplied without attempting to validate that such a version is obtainable from the repository chain.
Default value is: false.
User property is: forceVersion.
<generateBackupPoms> boolean 1.0-alpha-3 Controls whether a backup pom should be created.
Default value is: true.
User property is: generateBackupPoms.
<ignoredVersions> Set 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 is: maven.version.ignore.
<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 specifying 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.
User property is: includes.
<processDependencies> boolean 1.0-alpha-3 Whether to process the dependencies section of the project.
Default value is: true.
User property is: processDependencies.
<processDependencyManagement> boolean 1.0-alpha-3 Whether to process the dependencyManagement section of the project.
Default value is: true.
User property is: processDependencyManagement.
<processParent> boolean 2.3 Whether to process the parent section of the project. If not set will default to false.
Default value is: false.
User property is: processParent.
<ruleSet> RuleSet 2.13.0

Allows specifying the RuleSet object describing rules on artifact versions to ignore when considering updates.
<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>

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

<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

<depVersion>

The exact version to be applied for the included dependencies
  • Type: java.lang.String
  • Since: 2.3
  • Required: Yes
  • User Property: depVersion

<excludeReactor>

Whether to skip processing dependencies that are produced as part of the current reactor.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: excludeReactor
  • Default: true

<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 specifying 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
  • User Property: excludes

<forceVersion>

If set to true, will use whatever version is supplied without attempting to validate that such a version is obtainable from the repository chain.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: forceVersion
  • Default: false

<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
  • Since: 2.13.0
  • Required: No
  • User Property: maven.version.ignore

<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 specifying 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
  • User Property: includes

<processDependencies>

Whether to process the dependencies section of the project.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: processDependencies
  • Default: true

<processDependencyManagement>

Whether to process the dependencyManagement section of the project.
  • Type: boolean
  • Since: 1.0-alpha-3
  • Required: No
  • User Property: processDependencyManagement
  • Default: true

<processParent>

Whether to process the parent section of the project. If not set will default to false.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: processParent
  • Default: false

<ruleSet>

Allows specifying the 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