org.apache.maven.plugins.release

Class PrepareReleaseMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.apache.maven.plugins.release.AbstractReleaseMojo

org.apache.maven.plugins.release.PrepareReleaseMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

PrepareWithPomReleaseMojo

public class PrepareReleaseMojo
extends AbstractReleaseMojo

Prepare for a release in SCM. Steps through several phases to ensure the POM is ready to be released and then prepares SCM to eventually contain a tagged version of the release and a record in the local copy of the parameters used. This can be followed by a call to release:perform. For more info see http://maven.apache.org/plugins/maven-release-plugin/examples/prepare-release.html.

Version:

$Id: PrepareReleaseMojo.java 1039453 2010-11-26 16:41:46Z stephenc $

Author:

John Casey, Emmanuel Venisse, Jason van Zyl, Brett Porter

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.maven.execution.MavenSession	session

Fields inherited from class org.apache.maven.plugins.release.AbstractReleaseMojo

basedir, javaHome, localRepoDirectory, mavenExecutorId, mavenHome, project, reactorProjects, releaseManager, settings

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

ROLE

Constructor Summary

Constructors

Constructor and Description
PrepareReleaseMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()
protected void	prepareRelease(boolean generateReleasePoms)

Methods inherited from class org.apache.maven.plugins.release.AbstractReleaseMojo

addArgument, createReleaseDescriptor, getAdditionalProfiles, getReactorProjects, getReleaseEnvironment, mergeCommandLineConfig, setBasedir

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

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

session

protected org.apache.maven.execution.MavenSession session

Since:

2.0

Constructor Detail

PrepareReleaseMojo

public PrepareReleaseMojo()

Method Detail

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 AbstractReleaseMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

prepareRelease

protected void prepareRelease(boolean generateReleasePoms)
                       throws org.apache.maven.plugin.MojoExecutionException,
                              org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException