org.apache.maven.shared.release.phase

Interface ReleasePhase

All Known Implementing Classes:

AbstractReleasePhase

public interface ReleasePhase

A phase in the release cycle.

Author:

Brett Porter

Method Summary

Modifier and Type	Method and Description
ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects) Execute the phase.
ReleaseResult	simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects) Simulate the phase, but don't make any changes to the project.

Method Detail

execute

ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                      ReleaseEnvironment releaseEnvironment,
                      List<org.apache.maven.project.MavenProject> reactorProjects)
               throws ReleaseExecutionException,
                      ReleaseFailureException

Execute the phase.

Parameters:

releaseDescriptor - the configuration to use

releaseEnvironment - the environmental configuration, such as Maven settings, Maven home, etc.

reactorProjects - the reactor projects

Returns:

the release result

Throws:

ReleaseExecutionException - an exception during the execution of the phase

ReleaseFailureException - a failure during the execution of the phase

simulate

ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                       ReleaseEnvironment releaseEnvironment,
                       List<org.apache.maven.project.MavenProject> reactorProjects)
                throws ReleaseExecutionException,
                       ReleaseFailureException

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

Parameters:

releaseDescriptor - the configuration to use

releaseEnvironment - the environmental configuration, such as Maven settings, Maven home, etc.

reactorProjects - the reactor projects

Returns:

the release result

Throws:

ReleaseExecutionException - an exception during the execution of the phase

ReleaseFailureException - a failure during the execution of the phase