org.apache.maven.plugins.release.phase
Interface ReleasePhase

All Known Implementing Classes:

AbstractReleasePhase, AbstractRewritePomsPhase, CheckDependencySnapshotsPhase, CheckPomPhase, EndReleasePhase, GenerateReleasePomsPhase, InputVariablesPhase, MapVersionsPhase, RemoveReleasePomsPhase, RewritePomsForDevelopmentPhase, RewritePomsForReleasePhase, RunGoalsPhase, ScmCheckModificationsPhase, ScmCommitPhase, ScmTagPhase

public interface ReleasePhase

A phase in the release cycle.

Author:

Brett Porter

Field Summary

static java.lang.String

ROLE The Plexus role.

Method Summary

void	clean(ReleaseConfiguration config) Clean up after a phase if it leaves any additional files in the checkout.
void	execute(ReleaseConfiguration releaseConfiguration) Execute the phase.
void	simulate(ReleaseConfiguration releaseConfiguration) Simulate the phase, but don't make any changes to the project.

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus role.

Method Detail

execute

void execute(ReleaseConfiguration releaseConfiguration)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Execute the phase.

Parameters:

releaseConfiguration - the configuration to use

Throws:

ReleaseExecutionException - an exception during the execution of the phase

ReleaseFailureException - a failure during the execution of the phase

simulate

void simulate(ReleaseConfiguration releaseConfiguration)
              throws ReleaseExecutionException,
                     ReleaseFailureException

Simulate the phase, but don't make any changes to the project.

Parameters:

releaseConfiguration - the configuration to use

Throws:

ReleaseExecutionException - an exception during the execution of the phase

ReleaseFailureException - a failure during the execution of the phase

clean

void clean(ReleaseConfiguration config)

Clean up after a phase if it leaves any additional files in the checkout.

Parameters:

config - the configuration to use