ScmBranchPhase (Maven Release Manager 2.4.2 API)

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

All Implemented Interfaces:

ReleasePhase, org.codehaus.plexus.logging.LogEnabled
```
public class ScmBranchPhase
extends AbstractReleasePhase
```
Branch the SCM repository.

Author:

Emmanuel Venisse

Plexus component:
role:
"org.apache.maven.shared.release.phase.ReleasePhase"
role-hint:
"scm-branch"

Field Summary
- Fields inherited from interface org.apache.maven.shared.release.phase.ReleasePhase
  ROLE

Constructor Summary

Constructors
Constructor and Description

ScmBranchPhase()

Constructors
Constructor and Description
`ScmBranchPhase()`

Method Summary

Methods
Modifier and Type	Method and Description
`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, 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
  - ScmBranchPhase
```
public ScmBranchPhase()
```
- 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

Class ScmBranchPhase

Field Summary

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.AbstractReleasePhase

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

Methods inherited from class java.lang.Object

Constructor Detail

ScmBranchPhase

Method Detail

execute

simulate