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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, boolean dryRun)
          Branch a project
 void branch(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, boolean dryRun, ReleaseManagerListener listener)
          Branch a project
 void branch(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean dryRun)
          Deprecated. Use branch(ReleaseDescriptor, ReleaseEnvironment, List, boolean) instead.
 void branch(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean dryRun, ReleaseManagerListener listener)
          Deprecated. Use branch(ReleaseDescriptor, ReleaseEnvironment, List, boolean, ReleaseManagerListener) instead.
 void clean(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseManagerListener listener, java.util.List reactorProjects)
          Clean a release.
 void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects)
          Perform a release.
 void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, boolean clean)
          Perform a release, and optionnaly cleanup.
 void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, ReleaseManagerListener listener)
          Perform a release.
 void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects)
          Deprecated. Use perform(ReleaseDescriptor, ReleaseEnvironment, List) instead
 void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean clean)
          Deprecated. Use perform(ReleaseDescriptor, ReleaseEnvironment, List, boolean) instead.
 void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, ReleaseManagerListener listener)
          Deprecated. Use perform(ReleaseDescriptor, ReleaseEnvironment, List, ReleaseManagerListener) instead.
 ReleaseResult performWithResult(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, ReleaseManagerListener listener)
           
 ReleaseResult performWithResult(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, ReleaseManagerListener listener)
          Deprecated. Use performWithResult(ReleaseDescriptor, ReleaseEnvironment, List, ReleaseManagerListener) instead.
 void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects)
          Prepare a release.
 void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, boolean resume, boolean dryRun)
          Prepare a release.
 void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, boolean resume, boolean dryRun, ReleaseManagerListener listener)
          Prepare a release.
 void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects)
          Deprecated. Use prepare(ReleaseDescriptor, ReleaseEnvironment, List) instead.
 void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean resume, boolean dryRun)
          Deprecated. Use prepare(ReleaseDescriptor, ReleaseEnvironment, List, boolean, boolean) instead.
 void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean resume, boolean dryRun, ReleaseManagerListener listener)
          Deprecated. Use prepare(ReleaseDescriptor, ReleaseEnvironment, List, boolean, boolean, ReleaseManagerListener) instead.
 ReleaseResult prepareWithResult(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, boolean resume, boolean dryRun, ReleaseManagerListener listener)
           
 ReleaseResult prepareWithResult(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, boolean resume, boolean dryRun, ReleaseManagerListener listener)
          Deprecated. Use prepareWithResult(ReleaseDescriptor, ReleaseEnvironment, List, boolean, boolean, ReleaseManagerListener) instead.
 void rollback(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects)
          Rollback changes made by the previous release
 void rollback(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, java.util.List reactorProjects, ReleaseManagerListener listener)
          Rollback changes made by the previous release
 void rollback(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects)
          Deprecated. Use rollback(ReleaseDescriptor, ReleaseEnvironment, List) instead.
 void rollback(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor, org.apache.maven.settings.Settings settings, java.util.List reactorProjects, ReleaseManagerListener listener)
          Deprecated. Use rollback(ReleaseDescriptor, ReleaseEnvironment, List, ReleaseManagerListener) instead.
 

Field Detail

ROLE

static final java.lang.String ROLE
The Plexus role.

Method Detail

prepare

void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             java.util.List reactorProjects)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Prepare a release.

Parameters:
releaseDescriptor - the configuration to pass to the preparation steps
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Deprecated. Use prepare(ReleaseDescriptor, ReleaseEnvironment, List) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             java.util.List reactorProjects,
             boolean resume,
             boolean dryRun)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Prepare a release.

Parameters:
releaseDescriptor - the configuration to pass to the preparation steps
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             boolean resume,
             boolean dryRun)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Deprecated. Use prepare(ReleaseDescriptor, ReleaseEnvironment, List, boolean, boolean) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             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
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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

prepare

void prepare(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             boolean resume,
             boolean dryRun,
             ReleaseManagerListener listener)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Deprecated. Use prepare(ReleaseDescriptor, ReleaseEnvironment, List, boolean, boolean, ReleaseManagerListener) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
                                ReleaseEnvironment releaseEnvironment,
                                java.util.List reactorProjects,
                                boolean resume,
                                boolean dryRun,
                                ReleaseManagerListener listener)

prepareWithResult

ReleaseResult prepareWithResult(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
                                org.apache.maven.settings.Settings settings,
                                java.util.List reactorProjects,
                                boolean resume,
                                boolean dryRun,
                                ReleaseManagerListener listener)
Deprecated. Use prepareWithResult(ReleaseDescriptor, ReleaseEnvironment, List, boolean, boolean, ReleaseManagerListener) instead.


perform

void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             java.util.List reactorProjects)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Perform a release.

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Deprecated. Use perform(ReleaseDescriptor, ReleaseEnvironment, List) instead

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             java.util.List reactorProjects,
             ReleaseManagerListener listener)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Perform a release.

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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

perform

void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             ReleaseManagerListener listener)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Deprecated. Use perform(ReleaseDescriptor, ReleaseEnvironment, List, ReleaseManagerListener) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
                                ReleaseEnvironment releaseEnvironment,
                                java.util.List reactorProjects,
                                ReleaseManagerListener listener)

performWithResult

ReleaseResult performWithResult(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
                                org.apache.maven.settings.Settings settings,
                                java.util.List reactorProjects,
                                ReleaseManagerListener listener)
Deprecated. Use performWithResult(ReleaseDescriptor, ReleaseEnvironment, List, ReleaseManagerListener) instead.


perform

void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             ReleaseEnvironment releaseEnvironment,
             java.util.List reactorProjects,
             boolean clean)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Perform a release, and optionnaly cleanup.

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
reactorProjects - the reactor projects
clean - flag to clean the release after perform
Throws:
ReleaseExecutionException - if there is a problem performing the release
ReleaseFailureException - if there is a problem performing the release

perform

void perform(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
             org.apache.maven.settings.Settings settings,
             java.util.List reactorProjects,
             boolean clean)
             throws ReleaseExecutionException,
                    ReleaseFailureException
Deprecated. Use perform(ReleaseDescriptor, ReleaseEnvironment, List, boolean) instead.

Perform a release, and optionnaly cleanup.

Parameters:
releaseDescriptor - the configuration to use for release
settings - the settings.xml configuration
reactorProjects - the reactor projects
clean - flag to clean the release after perform
Throws:
ReleaseExecutionException - if there is a problem performing the release
ReleaseFailureException - if there is a problem performing the release

clean

void clean(org.apache.maven.shared.release.config.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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
              ReleaseEnvironment releaseEnvironment,
              java.util.List reactorProjects)
              throws ReleaseExecutionException,
                     ReleaseFailureException
Rollback changes made by the previous release

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
              org.apache.maven.settings.Settings settings,
              java.util.List reactorProjects)
              throws ReleaseExecutionException,
                     ReleaseFailureException
Deprecated. Use rollback(ReleaseDescriptor, ReleaseEnvironment, List) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
              ReleaseEnvironment releaseEnvironment,
              java.util.List reactorProjects,
              ReleaseManagerListener listener)
              throws ReleaseExecutionException,
                     ReleaseFailureException
Rollback changes made by the previous release

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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

rollback

void rollback(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
              org.apache.maven.settings.Settings settings,
              java.util.List reactorProjects,
              ReleaseManagerListener listener)
              throws ReleaseExecutionException,
                     ReleaseFailureException
Deprecated. Use rollback(ReleaseDescriptor, ReleaseEnvironment, List, ReleaseManagerListener) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
            ReleaseEnvironment releaseEnvironment,
            java.util.List reactorProjects,
            boolean dryRun)
            throws ReleaseExecutionException,
                   ReleaseFailureException
Branch a project

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
            org.apache.maven.settings.Settings settings,
            java.util.List reactorProjects,
            boolean dryRun)
            throws ReleaseExecutionException,
                   ReleaseFailureException
Deprecated. Use branch(ReleaseDescriptor, ReleaseEnvironment, List, boolean) instead.

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(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
            ReleaseEnvironment releaseEnvironment,
            java.util.List reactorProjects,
            boolean dryRun,
            ReleaseManagerListener listener)
            throws ReleaseExecutionException,
                   ReleaseFailureException
Branch a project

Parameters:
releaseDescriptor - the configuration to use for release
releaseEnvironment - settings, maven-home, java-home, etc. to use during release.
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

branch

void branch(org.apache.maven.shared.release.config.ReleaseDescriptor releaseDescriptor,
            org.apache.maven.settings.Settings settings,
            java.util.List reactorProjects,
            boolean dryRun,
            ReleaseManagerListener listener)
            throws ReleaseExecutionException,
                   ReleaseFailureException
Deprecated. Use branch(ReleaseDescriptor, ReleaseEnvironment, List, boolean, ReleaseManagerListener) instead.

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


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.