org.apache.maven.plugins.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	clean(ReleaseConfiguration releaseConfiguration) Clean a release.
void	perform(ReleaseConfiguration releaseConfiguration, java.io.File checkoutDirectory, java.lang.String goals, boolean useReleaseProfile) Perform a release.
void	prepare(ReleaseConfiguration releaseConfiguration) Prepare a release.
void	prepare(ReleaseConfiguration releaseConfiguration, boolean resume, boolean dryRun) Prepare a release.

Field Detail

ROLE

static final java.lang.String ROLE

The Plexus role.

Method Detail

prepare

void prepare(ReleaseConfiguration releaseConfiguration)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Prepare a release.

Parameters:

releaseConfiguration - the configuration to pass to the preparation steps

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

prepare

void prepare(ReleaseConfiguration releaseConfiguration,
             boolean resume,
             boolean dryRun)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Prepare a release.

Parameters:

releaseConfiguration - the configuration to pass to the preparation steps

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

perform

void perform(ReleaseConfiguration releaseConfiguration,
             java.io.File checkoutDirectory,
             java.lang.String goals,
             boolean useReleaseProfile)
             throws ReleaseExecutionException,
                    ReleaseFailureException

Perform a release.

Parameters:

releaseConfiguration - the configuration to use for release

checkoutDirectory - the location to checkout to and build from

goals - the goals to execute

useReleaseProfile - whether to use the release profile from the super POM or not

Throws:

ReleaseExecutionException - if there is a problem performing the release

ReleaseFailureException - if there is a problem performing the release

clean

void clean(ReleaseConfiguration releaseConfiguration)

Clean a release.

Parameters:

releaseConfiguration - the configuration to use for release