org.apache.maven.shared.release.phase
Class ScmCheckModificationsPhase

java.lang.Object
  org.codehaus.plexus.logging.AbstractLogEnabled
      org.apache.maven.shared.release.phase.AbstractReleasePhase
          org.apache.maven.shared.release.phase.ScmCheckModificationsPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled

public class ScmCheckModificationsPhase
extends AbstractReleasePhase

See if there are any local modifications to the files before proceeding with SCM operations and the release.

Author:

Brett Porter

Plexus component:

role:

"org.apache.maven.shared.release.phase.ReleasePhase"

role-hint:

"scm-check-modifications"

Field Summary

Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase

ROLE

Constructor Summary

ScmCheckModificationsPhase()

Method Summary

ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects) Execute the phase.
ReleaseResult	simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects) Simulate the phase, but don't make any changes to the project.

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase

clean, execute, getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn, simulate

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

ScmCheckModificationsPhase

public ScmCheckModificationsPhase()

Method Detail

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                             ReleaseEnvironment releaseEnvironment,
                             List<MavenProject> reactorProjects)
                      throws ReleaseExecutionException,
                             ReleaseFailureException

Description copied from interface: ReleasePhase

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

public ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
                              ReleaseEnvironment releaseEnvironment,
                              List<MavenProject> reactorProjects)
                       throws ReleaseExecutionException,
                              ReleaseFailureException

Description copied from interface: ReleasePhase

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