Fork me on GitHub
Built by Maven

versions:set-property

Full name:

org.codehaus.mojo:versions-maven-plugin:2.13.0:set-property

Description:

Set a property to a given version without any sanity checks. Please be careful this can lead to changes which might not build anymore. The sanity checks are done by other goals like update-properties or update-property etc. they are not done here. So use this goal with care.

Attributes:

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

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.
<autoLinkItems> boolean 2.5 Whether properties linking versions should be auto-detected or not.
Default value is: true.
User property is: autoLinkItems.
<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 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.
<newVersion> String 2.5 The new version to set the property.
User property is: newVersion.
<propertiesVersionsFile> String 2.9 A property file name containing: property=value, to update several properties at the same time. If 'property' and 'newVersion' are also used, they will be ignored.
User property is: propertiesVersionsFile.
<property> String 2.5 A property to update. You can also specify multiple property names separated by "," which are all set to the same new version.
User property is: property.
<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

<autoLinkItems>

Whether properties linking versions should be auto-detected or not.
  • Type: boolean
  • Since: 2.5
  • 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

<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

<newVersion>

The new version to set the property.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • User Property: newVersion

<propertiesVersionsFile>

A property file name containing: property=value, to update several properties at the same time. If 'property' and 'newVersion' are also used, they will be ignored.
  • Type: java.lang.String
  • Since: 2.9
  • Required: No
  • User Property: propertiesVersionsFile

<property>

A property to update. You can also specify multiple property names separated by "," which are all set to the same new version.
  • Type: java.lang.String
  • Since: 2.5
  • Required: No
  • User Property: property

<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