org.apache.maven.shared.release.phase

Class ScmTagPhase

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.shared.release.phase.AbstractReleasePhase

org.apache.maven.shared.release.phase.ScmTagPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled

public class ScmTagPhase
extends AbstractReleasePhase

Tag the SCM repository after committing the release.

Field Summary

Fields

Modifier and Type	Field and Description
private ScmRepositoryConfigurator	scmRepositoryConfigurator Tool that gets a configured SCM repository from release configuration.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
ScmTagPhase()

Method Summary

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

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

clean, execute, getReleaseResultSuccess, 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

Field Detail

scmRepositoryConfigurator

private ScmRepositoryConfigurator scmRepositoryConfigurator

Tool that gets a configured SCM repository from release configuration.

Constructor Detail

ScmTagPhase

public ScmTagPhase()

Method Detail

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
                             ReleaseEnvironment releaseEnvironment,
                             java.util.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

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,
                              java.util.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

Throws:

ReleaseExecutionException - an exception during the execution of the phase

ReleaseFailureException - a failure during the execution of the phase

validateConfiguration

private static void validateConfiguration(ReleaseDescriptor releaseDescriptor)
                                   throws ReleaseFailureException

Throws:

ReleaseFailureException