org.apache.maven.shared.release
Interface ReleaseManager

All Known Implementing Classes:

DefaultReleaseManager

public interface ReleaseManager

Release management classes.

Author:

Brett Porter

Field Summary

static java.lang.String

ROLE The Plexus role.

Method Summary

void	branch(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean dryRun) Branch a project
void	branch(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean dryRun, ReleaseManagerListener listener) Branch a project
void	clean(ReleaseDescriptor releaseDescriptor, ReleaseManagerListener listener, java.util.List reactorProjects) Clean a release.
void	perform(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects) Perform a release.
void	perform(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, ReleaseManagerListener listener) Perform a release.
ReleaseResult	performWithResult(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, ReleaseManagerListener listener)
void	prepare(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects) Prepare a release.
void	prepare(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean resume, boolean dryRun) Prepare a release.
void	prepare(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean resume, boolean dryRun, ReleaseManagerListener listener) Prepare a release.
ReleaseResult	prepareWithResult(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean resume, boolean dryRun, ReleaseManagerListener listener)
void	rollback(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects) Rollback changes made by the previous release
void	rollback(ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, ReleaseManagerListener listener) Rollback changes made by the previous release

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus role.

Method Detail

prepare

void prepare(ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Prepare a release.

Parameters:

releaseDescriptor - the configuration to pass to the preparation steps

settings - the settings.xml configuration

reactorProjects - the reactor projects

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

prepare

void prepare(ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             boolean resume,
             boolean dryRun)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Prepare a release.

Parameters:

releaseDescriptor - the configuration to pass to the preparation steps

settings - the settings.xml configuration

reactorProjects - the reactor projects

resume - resume a previous release, if the properties file exists

dryRun - do not commit any changes to the file system or SCM

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

prepare

void prepare(ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             boolean resume,
             boolean dryRun,
             ReleaseManagerListener listener)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Prepare a release.

Parameters:

releaseDescriptor - the configuration to pass to the preparation steps

settings - the settings.xml configuration

reactorProjects - the reactor projects

resume - resume a previous release, if the properties file exists

dryRun - do not commit any changes to the file system or SCM

listener - the listener

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

prepareWithResult

ReleaseResult prepareWithResult(ReleaseDescriptor releaseDescriptor,
                                org.apache.maven.settings.Settings settings,
                                java.util.List reactorProjects,
                                boolean resume,
                                boolean dryRun,
                                ReleaseManagerListener listener)

perform

void perform(ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Perform a release.

Parameters:

releaseDescriptor - the configuration to use for release

settings - the settings.xml configuration

reactorProjects - the reactor projects

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

perform

void perform(ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             ReleaseManagerListener listener)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Perform a release.

Parameters:

releaseDescriptor - the configuration to use for release

settings - the settings.xml configuration

reactorProjects - the reactor projects

listener - the listener

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

performWithResult

ReleaseResult performWithResult(ReleaseDescriptor releaseDescriptor,
                                org.apache.maven.settings.Settings settings,
                                java.util.List reactorProjects,
                                ReleaseManagerListener listener)

clean

void clean(ReleaseDescriptor releaseDescriptor,
           ReleaseManagerListener listener,
           java.util.List reactorProjects)

Clean a release.

Parameters:

releaseDescriptor - the configuration to use for release

reactorProjects - the reactor projects

rollback

void rollback(ReleaseDescriptor releaseDescriptor,
              org.apache.maven.settings.Settings settings,
              java.util.List reactorProjects)
              throws ReleaseExecutionException,
                     ReleaseFailureException

Rollback changes made by the previous release

Parameters:

releaseDescriptor - the configuration to use for release

settings - the settings.xml configuration

reactorProjects - the reactor projects

Throws:

ReleaseExecutionException - if there is a problem during release rollback

ReleaseFailureException - if there is a problem during release rollback

rollback

void rollback(ReleaseDescriptor releaseDescriptor,
              org.apache.maven.settings.Settings settings,
              java.util.List reactorProjects,
              ReleaseManagerListener listener)
              throws ReleaseExecutionException,
                     ReleaseFailureException

Rollback changes made by the previous release

Parameters:

releaseDescriptor - the configuration to use for release

settings - the settings.xml configuration

reactorProjects - the reactor projects

listener - the listener

Throws:

ReleaseExecutionException - if there is a problem during release rollback

ReleaseFailureException - if there is a problem during release rollback

branch

void branch(ReleaseDescriptor releaseDescriptor,
            org.apache.maven.settings.Settings settings,
            java.util.List reactorProjects,
            boolean dryRun)
            throws ReleaseExecutionException,
                   ReleaseFailureException

Branch a project

Parameters:

releaseDescriptor - the configuration to use for release

settings - the settings.xml configuration

reactorProjects - the reactor projects

dryRun - do not commit any changes to the file system or SCM

Throws:

ReleaseExecutionException - if there is a problem during release rollback

ReleaseFailureException - if there is a problem during release rollback

branch

void branch(ReleaseDescriptor releaseDescriptor,
            org.apache.maven.settings.Settings settings,
            java.util.List reactorProjects,
            boolean dryRun,
            ReleaseManagerListener listener)
            throws ReleaseExecutionException,
                   ReleaseFailureException

Branch a project

Parameters:

releaseDescriptor - the configuration to use for release

settings - the settings.xml configuration

reactorProjects - the reactor projects

dryRun - do not commit any changes to the file system or SCM

listener - the listener

Throws:

ReleaseExecutionException - if there is a problem during release rollback

ReleaseFailureException - if there is a problem during release rollback