Class RollbackReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.release.AbstractReleaseMojo

org.apache.maven.plugins.release.AbstractScmReleaseMojo

org.apache.maven.plugins.release.RollbackReleaseMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="rollback",
      aggregator=true)
public class RollbackReleaseMojo
extends AbstractScmReleaseMojo

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/examples/rollback-release.html.

Since:

2.0-beta-5

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
private String	scmRollbackCommitComment	The SCM commit comment when rolling back.

Fields inherited from class AbstractReleaseMojo

project, releaseManager, session

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
RollbackReleaseMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class AbstractScmReleaseMojo

buildScm, createReleaseDescriptor

Methods inherited from class AbstractReleaseMojo

addArgument, getAdditionalProfiles, getBasedir, getCommonBasedir, getReactorProjects, getReleaseEnvironment, getSettings, setBasedir, setPomFileName, setReleaseManager

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

scmRollbackCommitComment

@Parameter(defaultValue="@{prefix} rollback the release of @{releaseLabel}",
           property="scmRollbackCommitComment")
private String 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.

Since:

3.0.0

Constructor Details

RollbackReleaseMojo

public RollbackReleaseMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
org.apache.maven.plugin.MojoFailureException

Specified by:

execute in interface org.apache.maven.plugin.Mojo

Overrides:

execute in class AbstractScmReleaseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException