org.apache.maven.plugins.release
Class PrepareReleaseMojo

java.lang.Object
  extended by org.apache.maven.plugin.AbstractMojo
      extended by org.apache.maven.plugins.release.AbstractReleaseMojo
          extended by org.apache.maven.plugins.release.PrepareReleaseMojo
All Implemented Interfaces:
ContextEnabled, 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.html 816536 2012-05-08 11:41:06Z hboutemy $
Author:
John Casey, Emmanuel Venisse, Jason van Zyl, Brett Porter
Aggregates the Maven project and its child modules.
Is defined by the goal name:
prepare

Field Summary
protected  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
PrepareReleaseMojo()
           
 
Method Summary
 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 MavenSession session
Since:
2.0
Is defined by:
expression:
${session}
Is readonly.
Is required.
Constructor Detail

PrepareReleaseMojo

public PrepareReleaseMojo()
Method Detail

execute

public void execute()
             throws MojoExecutionException,
                    MojoFailureException

Specified by:
execute in interface Mojo
Overrides:
execute in class AbstractReleaseMojo
Throws:
MojoExecutionException
MojoFailureException

prepareRelease

protected void prepareRelease(boolean generateReleasePoms)
                       throws MojoExecutionException,
                              MojoFailureException
Throws:
MojoExecutionException
MojoFailureException


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.