Built by Maven

release:rollback

Full name:

org.apache.maven.plugins:maven-release-plugin:3.2.0:rollback

Description:

Rollback changes made by a previous release. This requires that the previous release descriptor release.properties is still available in the local working copy. For more info see https://maven.apache.org/plugins/maven-release-plugin/usage/rollback-release.html.

Attributes:

  • Requires a Maven project to be executed.
  • Executes as an aggregator goal.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0-beta-5.

Optional Parameters

Name Type Since Description
<arguments> String - Additional arguments to pass to the Maven executions, separated by spaces.
User Property: arguments
Alias: prepareVerifyArgs
<javaHome> File 2.0-beta-8 The Java home parameter to use for forked Maven invocations.
Default: ${java.home}
<localRepoDirectory> File 2.0-beta-8 The command-line local repository directory in use for this build (if specified).
Default: ${maven.repo.local}
<mavenExecutorId> String 2.0-beta-8 Role hint of the org.apache.maven.shared.release.exec.MavenExecutor implementation to use.
Default: invoker
User Property: mavenExecutorId
<mavenHome> File 2.0-beta-8 The Maven home parameter to use for forked Maven invocations.
Default: ${maven.home}
<password> String - The password to use for authentication with the SCM.
See also: SCM Authentication
User Property: password
<pomFileName> String - The file name of the POM to execute any goals against. As of version 3.0.0, this defaults to the name of POM file of the project being built.
Default: ${project.file.name}
User Property: pomFileName
<privateKey> File 3.2.0 The path to the SSH private key to use for authentication with the SCM.
See also: SCM Authentication
User Property: privateKey
<providerImplementations> Map<String,String> 2.0-beta-6 Add a new or overwrite the default implementation per provider. The key is the scm prefix and the value is the role hint/provider id of the org.apache.maven.scm.provider.ScmProvider.
See also: org.apache.maven.scm.manager.ScmManager.setScmProviderImplementation(java.lang.String,java.lang.String), SCM Providers
<pushChanges> boolean 2.1 Whether to push changes to the upstream repository or not. Only applicable to distributed version control like Git. Is set to true by default to preserve backward compatibility.
Default: true
User Property: pushChanges
<releaseStrategyId> String 3.0.0-M5 The role-hint for the org.apache.maven.shared.release.strategy.Strategy implementation used to specify the phases per goal.
See also: org.apache.maven.shared.release.strategies.DefaultStrategy
Default: default
User Property: releaseStrategyId
<scmCommentPrefix> String 2.0-beta-5 The message prefix to use for all SCM changes.
Default: [maven-release-plugin]
User Property: scmCommentPrefix
<scmRollbackCommitComment> String 3.0.0-M5 The SCM commit comment when rolling back. Defaults to "@{prefix} rollback the release of @{releaseLabel}".

Property interpolation is performed on the value, but in order to ensure that the interpolation occurs during release, you must use @{...} to reference the properties rather than ${...}. The following properties are available:

  • prefix - The comment prefix.
  • groupId - The groupId of the root project.
  • artifactId - The artifactId of the root project.
  • releaseLabel - The release version of the root project.

Default: @{prefix} rollback the release of @{releaseLabel}
User Property: scmRollbackCommitComment
<scmShallowClone> boolean - When cloning a repository if it should be a shallow clone or a full clone.
Default: true
User Property: scmShallowClone
<serverId> String 3.2.0 The server id of the server which provides the credentials for the SCM in the settings.xml file. If not set the default lookup uses the SCM URL to construct the server id like this: server-id=scm-host[":"scm-port].

Currently the POM does not allow to specify a server id for the SCM section.

Explicit authentication information provided via username, password or privateKey will take precedence.


See also: SCM Authentication
Default: ${project.scm.id}
User Property: project.scm.id
<tag> String - The SCM tag to use.
User Property: tag
Alias: releaseLabel
<tagBase> String - The tag base directory in SVN, you must define it if you don't use the standard svn layout (trunk/tags/branches). For example, http://svn.apache.org/repos/asf/maven/plugins/tags. The URL is an SVN URL and does not include the SCM provider and protocol.
User Property: tagBase
<tagNameFormat> String 2.2.0 Format to use when generating the tag name if none is specified. Property interpolation is performed on the tag, but in order to ensure that the interpolation occurs during release, you must use @{...} to reference the properties rather than ${...}. The following properties are available:
  • groupId or project.groupId - The groupId of the root project.
  • artifactId or project.artifactId - The artifactId of the root project.
  • version or project.version - The release version of the root project.

Default: @{project.artifactId}-@{project.version}
User Property: tagNameFormat
<username> String - The username to use for authentication with the SCM.
See also: SCM Authentication
User Property: username
<workItem> String 3.0.0-M5 A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
User Property: workItem

Parameter Details

<arguments>

Additional arguments to pass to the Maven executions, separated by spaces.
  • Type: java.lang.String
  • Required: No
  • User Property: arguments
  • Alias: prepareVerifyArgs

<javaHome>

The Java home parameter to use for forked Maven invocations.
  • Type: java.io.File
  • Since: 2.0-beta-8
  • Required: No
  • Default: ${java.home}

<localRepoDirectory>

The command-line local repository directory in use for this build (if specified).
  • Type: java.io.File
  • Since: 2.0-beta-8
  • Required: No
  • Default: ${maven.repo.local}

<mavenExecutorId>

Role hint of the org.apache.maven.shared.release.exec.MavenExecutor implementation to use.
  • Type: java.lang.String
  • Since: 2.0-beta-8
  • Required: No
  • User Property: mavenExecutorId
  • Default: invoker

<mavenHome>

The Maven home parameter to use for forked Maven invocations.
  • Type: java.io.File
  • Since: 2.0-beta-8
  • Required: No
  • Default: ${maven.home}

<password>

The password to use for authentication with the SCM.
See also: SCM Authentication
  • Type: java.lang.String
  • Required: No
  • User Property: password

<pomFileName>

The file name of the POM to execute any goals against. As of version 3.0.0, this defaults to the name of POM file of the project being built.
  • Type: java.lang.String
  • Required: No
  • User Property: pomFileName
  • Default: ${project.file.name}

<privateKey>

The path to the SSH private key to use for authentication with the SCM.
See also: SCM Authentication
  • Type: java.io.File
  • Since: 3.2.0
  • Required: No
  • User Property: privateKey

<providerImplementations>

Add a new or overwrite the default implementation per provider. The key is the scm prefix and the value is the role hint/provider id of the org.apache.maven.scm.provider.ScmProvider.
See also: org.apache.maven.scm.manager.ScmManager.setScmProviderImplementation(java.lang.String,java.lang.String), SCM Providers
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 2.0-beta-6
  • Required: No

<pushChanges>

Whether to push changes to the upstream repository or not. Only applicable to distributed version control like Git. Is set to true by default to preserve backward compatibility.
  • Type: boolean
  • Since: 2.1
  • Required: No
  • User Property: pushChanges
  • Default: true

<releaseStrategyId>

The role-hint for the org.apache.maven.shared.release.strategy.Strategy implementation used to specify the phases per goal.
See also: org.apache.maven.shared.release.strategies.DefaultStrategy
  • Type: java.lang.String
  • Since: 3.0.0-M5
  • Required: No
  • User Property: releaseStrategyId
  • Default: default

<scmCommentPrefix>

The message prefix to use for all SCM changes.
  • Type: java.lang.String
  • Since: 2.0-beta-5
  • Required: No
  • User Property: scmCommentPrefix
  • Default: [maven-release-plugin]

<scmRollbackCommitComment>

The SCM commit comment when rolling back. Defaults to "@{prefix} rollback the release of @{releaseLabel}".

Property interpolation is performed on the value, but in order to ensure that the interpolation occurs during release, you must use @{...} to reference the properties rather than ${...}. The following properties are available:

  • prefix - The comment prefix.
  • groupId - The groupId of the root project.
  • artifactId - The artifactId of the root project.
  • releaseLabel - The release version of the root project.
  • Type: java.lang.String
  • Since: 3.0.0-M5
  • Required: No
  • User Property: scmRollbackCommitComment
  • Default: @{prefix} rollback the release of @{releaseLabel}

<scmShallowClone>

When cloning a repository if it should be a shallow clone or a full clone.
  • Type: boolean
  • Required: No
  • User Property: scmShallowClone
  • Default: true

<serverId>

The server id of the server which provides the credentials for the SCM in the settings.xml file. If not set the default lookup uses the SCM URL to construct the server id like this: server-id=scm-host[":"scm-port].

Currently the POM does not allow to specify a server id for the SCM section.

Explicit authentication information provided via username, password or privateKey will take precedence.


See also: SCM Authentication
  • Type: java.lang.String
  • Since: 3.2.0
  • Required: No
  • User Property: project.scm.id
  • Default: ${project.scm.id}

<tag>

The SCM tag to use.
  • Type: java.lang.String
  • Required: No
  • User Property: tag
  • Alias: releaseLabel

<tagBase>

The tag base directory in SVN, you must define it if you don't use the standard svn layout (trunk/tags/branches). For example, http://svn.apache.org/repos/asf/maven/plugins/tags. The URL is an SVN URL and does not include the SCM provider and protocol.
  • Type: java.lang.String
  • Required: No
  • User Property: tagBase

<tagNameFormat>

Format to use when generating the tag name if none is specified. Property interpolation is performed on the tag, but in order to ensure that the interpolation occurs during release, you must use @{...} to reference the properties rather than ${...}. The following properties are available:
  • groupId or project.groupId - The groupId of the root project.
  • artifactId or project.artifactId - The artifactId of the root project.
  • version or project.version - The release version of the root project.
  • Type: java.lang.String
  • Since: 2.2.0
  • Required: No
  • User Property: tagNameFormat
  • Default: @{project.artifactId}-@{project.version}

<username>

The username to use for authentication with the SCM.
See also: SCM Authentication
  • Type: java.lang.String
  • Required: No
  • User Property: username

<workItem>

A workItem for SCMs like RTC, TFS etc, that may require additional information to perform a pushChange operation.
  • Type: java.lang.String
  • Since: 3.0.0-M5
  • Required: No
  • User Property: workItem