org.apache.maven.plugin.cxx.utils.release

Interface CxxReleasePhase

All Known Implementing Classes:

CheckDependencySnapshotsPhase, CopyPomsIntoBranchPhase, CreateBackupPomsPhase, CreateTagNamePhase, CxxAbstractMavenReleasePluginPhase, CxxAbstractReleasePhase, MapVersionsPhase, PreCheckPomPhase, RestoreBackupPomsPhase, RewritePomsForBranchPhase, RewritePomsForDevelopmentPhase, RewritePomsForReleasePhase, ScmBranchPhase, ScmCheckModificationPhase, ScmCommitBranchPhase, ScmCommitDevelopmentPhase, ScmCommitReleasePhase, ScmTagPhase

public interface CxxReleasePhase

A phase in the cxx release/branch goal. $FB derived from org.apache.maven.shared.release.phase.ReleasePhase;

Author:

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE The Plexus role.

Method Summary

Modifier and Type	Method and Description
org.apache.maven.shared.release.ReleaseResult	clean(List<org.apache.maven.project.MavenProject> reactorProjects) Clean up after a phase if it leaves any additional files in the checkout.
org.apache.maven.shared.release.ReleaseResult	run(CxxReleaseDescriptor releaseDescriptor, org.apache.maven.shared.release.env.ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects) Execute the phase.
void	setLog(org.apache.maven.plugin.logging.Log log)

Field Detail

ROLE

static final String ROLE

The Plexus role.

Method Detail

run

org.apache.maven.shared.release.ReleaseResult run(CxxReleaseDescriptor releaseDescriptor,
                                                  org.apache.maven.shared.release.env.ReleaseEnvironment releaseEnvironment,
                                                  List<org.apache.maven.project.MavenProject> reactorProjects)
                                           throws org.apache.maven.plugin.MojoExecutionException,
                                                  org.apache.maven.plugin.MojoFailureException

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

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

clean

org.apache.maven.shared.release.ReleaseResult clean(List<org.apache.maven.project.MavenProject> reactorProjects)

Clean up after a phase if it leaves any additional files in the checkout.

Parameters:

reactorProjects - the reactor projects

Returns:

the release result

setLog

void setLog(org.apache.maven.plugin.logging.Log log)

Parameters:

log -