ScmCommitPreparationPhase (Maven Release Manager 2.5.1 API)

java.lang.Object
- org.codehaus.plexus.logging.AbstractLogEnabled
- - org.apache.maven.shared.release.phase.AbstractReleasePhase
  - - org.apache.maven.shared.release.phase.AbstractScmCommitPhase
    - - org.apache.maven.shared.release.phase.ScmCommitPreparationPhase

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled
```
public class ScmCommitPreparationPhase
extends AbstractScmCommitPhase
```
Commit the changes that were done to prepare the branch or tag to the SCM.

Author:

Brett Porter

Field Summary
- Fields inherited from class org.apache.maven.shared.release.phase.AbstractScmCommitPhase
  afterBranchOrTag, beforeBranchOrTag, messageFormat, scmRepositoryConfigurator
- Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase
  ROLE

Constructor Summary

Constructors
Constructor and Description

ScmCommitPreparationPhase()

Constructors
Constructor and Description
`ScmCommitPreparationPhase()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`runLogic(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<MavenProject> reactorProjects, ReleaseResult result, boolean simulating)`
`protected void`	`validateConfiguration(ReleaseDescriptor releaseDescriptor)`

Methods inherited from class org.apache.maven.shared.release.phase.AbstractScmCommitPhase
createMessage, createPomFiles, createPomFiles, execute, performCheckins, simulate, simulateCheckins

Methods inherited from class org.apache.maven.shared.release.phase.AbstractReleasePhase
clean, execute, getReleaseResultSuccess, getResourceBundle, 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
- ScmCommitPreparationPhase
```
public ScmCommitPreparationPhase()
```

Method Detail

runLogic

protected void runLogic(ReleaseDescriptor releaseDescriptor,
            ReleaseEnvironment releaseEnvironment,
            List<MavenProject> reactorProjects,
            ReleaseResult result,
            boolean simulating)
                 throws ReleaseScmCommandException,
                        ReleaseExecutionException,
                        ReleaseScmRepositoryException

Specified by:: runLogic in class AbstractScmCommitPhase
Throws:: ReleaseScmCommandException; ReleaseExecutionException; ReleaseScmRepositoryException

validateConfiguration

protected void validateConfiguration(ReleaseDescriptor releaseDescriptor)
                              throws ReleaseFailureException

Overrides:: validateConfiguration in class AbstractScmCommitPhase
Throws:: ReleaseFailureException

Class ScmCommitPreparationPhase

Field Summary

Fields inherited from class org.apache.maven.shared.release.phase.AbstractScmCommitPhase

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

ScmCommitPreparationPhase

Method Detail

runLogic

validateConfiguration