Build Helper Maven Plugin – build-helper:parse-version

build-helper:parse-version

Full name:

org.codehaus.mojo:build-helper-maven-plugin:3.5.0:parse-version

Description:

Parse a version string and set properties containing the component parts of the version. This mojo sets the following properties:

  [propertyPrefix].majorVersion
  [propertyPrefix].minorVersion
  [propertyPrefix].incrementalVersion
  [propertyPrefix].qualifier
  [propertyPrefix].buildNumber

Where the propertyPrefix is the string set in the mojo parameter. The parsing of the above is based on the following format of the version:

 <majorversion [> . <minorversion [> . <incrementalversion ] ] [> - <buildnumber | qualifier ]>

It will be tried to parse the version as an OSGi version. It this is successful the following property will be set accordingly. If this is not possible a warning will be emitted.

  [propertyPrefix].osgiVersion

This goal also sets the following properties:

  [propertyPrefix].nextMajorVersion
  [propertyPrefix].nextMinorVersion
  [propertyPrefix].nextIncrementalVersion
  [propertyPrefix].nextBuildNumber

This goal also sets the following properties:

  [formattedPropertyPrefix].majorVersion
  [formattedPropertyPrefix].minorVersion
  [formattedPropertyPrefix].incrementalVersion
  [formattedPropertyPrefix].buildNumber

This goal also sets the following properties:

  [formattedPropertyPrefix].nextMajorVersion
  [formattedPropertyPrefix].nextMinorVersion
  [formattedPropertyPrefix].nextIncrementalVersion
  [formattedPropertyPrefix].nextBuildNumber

There is another property set which is named [propertyPrefix].qualifier and furthermore another property which is named [propertyPrefix].qualifier? which contains a prefix - if the qualifier contains anything otherwise the whole property is simply empty.

mvn build-helper:parse-version versions:set \
  -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.nextMinorVersion}.\${parsedVersion.incrementalVersion}\${parsedVersion.qualifier?}

The above properties contain simply incremented versions of the parsed version informations. Those can now be used to update the version of your project via the following to the next Major version:

  mvn build-helper:parse-version versions:set \
     -DnewVersion=\${parsedVersion.nextMajorVersion}.0.0 \
     versions:commit

It can of course being used to increment the minor version:

  mvn build-helper:parse-version versions:set \
     -DnewVersion=\${parsedVersion.majorVersion}.\${parsedVersion.nextMinorVersion}.0 \
     versions:commit

This can make an upgrade of the versions of your project very convenient.

Attributes:

Requires a Maven project to be executed.
The goal is thread-safe and supports parallel builds.
Since version: 1.3.
Binds by default to the lifecycle phase: validate.

Optional Parameters

Name	Type	Since	Description
`<formatBuildNumber>`	`String`	`3.0.0`	See also: Formatter syntax Default value is: `%02d`.
`<formatIncremental>`	`String`	`3.0.0`	See also: Formatter syntax Default value is: `%02d`.
`<formatMajor>`	`String`	`3.0.0`	This can be used to make a particular format of the major number possible like padding it with zeros etc. See also: Formatter syntax Default value is: `%02d`.
`<formatMinor>`	`String`	`3.0.0`	See also: Formatter syntax Default value is: `%02d`.
`<formattedPropertyPrefix>`	`String`	`3.0.0`	Prefix string to use for the set of formatted version properties. Default value is: `formattedVersion`.
`<propertyPrefix>`	`String`	`-`	Prefix string to use for the set of version properties. Default value is: `parsedVersion`.
`<qualifierPrefix>`	`String`	`3.1.0`	By using `qualifierPrefix` you can change the prefix which is used to prefix the qualifier if not empty. Default value is: `-`.
`<versionString>`	`String`	`-`	The version string to parse. Default value is: `${project.version}`. User property is: `versionString`.