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

@Component(role=ReleasePhase.class,
           hint="scm-check-modifications")
public class ScmCheckModificationsPhase
extends AbstractReleasePhase

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

Field Summary

Fields

Modifier and Type	Field	Description
private Set<String>	exclusionPatterns	The filepatterns to exclude from the status check.
private ScmRepositoryConfigurator	scmRepositoryConfigurator	Tool that gets a configured SCM repository from release configuration.
private Map<String, ScmTranslator>	scmTranslators	SCM URL translators mapped by provider name.

Constructor Summary

Constructors

Constructor	Description
ScmCheckModificationsPhase()

Method Summary

Modifier and Type	Method	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.

Methods inherited from class AbstractReleasePhase

getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn

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

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class Object

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

Field Details

scmRepositoryConfigurator

@Requirement
private ScmRepositoryConfigurator scmRepositoryConfigurator

Tool that gets a configured SCM repository from release configuration.

scmTranslators

@Requirement(role=ScmTranslator.class)
private Map<String, ScmTranslator> scmTranslators

SCM URL translators mapped by provider name.

exclusionPatterns

private Set<String> exclusionPatterns

The filepatterns to exclude from the status check.

Constructor Details

ScmCheckModificationsPhase

public ScmCheckModificationsPhase()

Method Details

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.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<org.apache.maven.project.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