org.apache.maven.continuum.release
Interface ContinuumReleaseManager

All Known Implementing Classes:

DefaultContinuumReleaseManager

public interface ContinuumReleaseManager

The Continuum Release Manager is responsible for performing releases based on a release descriptor that has been received by the Maven Release Plugin.

Version:

$Id: ContinuumReleaseManager.java 751433 2009-03-08 14:41:33Z ctan $

Author:

Jason van Zyl

Field Summary

static String

ROLE

Method Summary

Map	getListeners()
Map	getPreparedReleases()
Map	getReleaseResults()
void	perform(String releaseId, File buildDirectory, String goals, String arguments, boolean useReleaseProfile, ContinuumReleaseManagerListener listener) Perform a release based on a given releaseId
void	perform(String releaseId, File buildDirectory, String goals, String arguments, boolean useReleaseProfile, ContinuumReleaseManagerListener listener, LocalRepository repository)
void	perform(String releaseId, String workingDirectory, File buildDirectory, String goals, String arguments, boolean useReleaseProfile, ContinuumReleaseManagerListener listener) Perform a release based on a release descriptor received by the Maven Release Plugin.
String	prepare(Project project, Properties releaseProperties, Map<String,String> releaseVersions, Map<String,String> developmentVersions, ContinuumReleaseManagerListener listener, String workingDirectory) Prepare a project for release
String	prepare(Project project, Properties releaseProperties, Map<String,String> releaseVersions, Map<String,String> developmentVersions, ContinuumReleaseManagerListener listener, String workingDirectory, Map<String,String> environments, String executable) Prepare a project for release
void	rollback(String releaseId, String workingDirectory, ContinuumReleaseManagerListener listener) Rollback changes made by a previous release.
String	sanitizeTagName(String scmUrl, String tagName) Clean up the tagname to respect the scm provider policy.

Field Detail

ROLE

static final String ROLE

Method Detail

prepare

String prepare(Project project,
               Properties releaseProperties,
               Map<String,String> releaseVersions,
               Map<String,String> developmentVersions,
               ContinuumReleaseManagerListener listener,
               String workingDirectory)
               throws ContinuumReleaseException

Prepare a project for release

Parameters:

project -

releaseProperties -

releaseVersions -

developmentVersions -

listener -

workingDirectory -

Returns:

Throws:

ContinuumReleaseException

prepare

String prepare(Project project,
               Properties releaseProperties,
               Map<String,String> releaseVersions,
               Map<String,String> developmentVersions,
               ContinuumReleaseManagerListener listener,
               String workingDirectory,
               Map<String,String> environments,
               String executable)
               throws ContinuumReleaseException

Prepare a project for release

Parameters:

project -

releaseProperties -

releaseVersions -

developmentVersions -

listener -

workingDirectory -

environments -

executable -

Returns:

Throws:

ContinuumReleaseException

perform

void perform(String releaseId,
             File buildDirectory,
             String goals,
             String arguments,
             boolean useReleaseProfile,
             ContinuumReleaseManagerListener listener)
             throws ContinuumReleaseException

Perform a release based on a given releaseId

Parameters:

releaseId -

buildDirectory -

goals -

useReleaseProfile -

Throws:

ContinuumReleaseException

perform

void perform(String releaseId,
             String workingDirectory,
             File buildDirectory,
             String goals,
             String arguments,
             boolean useReleaseProfile,
             ContinuumReleaseManagerListener listener)
             throws ContinuumReleaseException

Perform a release based on a release descriptor received by the Maven Release Plugin.

Parameters:

releaseId -

workingDirectory -

buildDirectory -

goals -

useReleaseProfile -

listener -

Throws:

ContinuumReleaseException

rollback

void rollback(String releaseId,
              String workingDirectory,
              ContinuumReleaseManagerListener listener)
              throws ContinuumReleaseException

Rollback changes made by a previous release.

Parameters:

releaseId -

workingDirectory -

listener -

Throws:

ContinuumReleaseException

getPreparedReleases

Map getPreparedReleases()

getReleaseResults

Map getReleaseResults()

getListeners

Map getListeners()

perform

void perform(String releaseId,
             File buildDirectory,
             String goals,
             String arguments,
             boolean useReleaseProfile,
             ContinuumReleaseManagerListener listener,
             LocalRepository repository)
             throws ContinuumReleaseException

Throws:

ContinuumReleaseException

sanitizeTagName

String sanitizeTagName(String scmUrl,
                       String tagName)
                       throws Exception

Clean up the tagname to respect the scm provider policy.

Parameters:

scmUrl - The scm url

tagName - The tag name

Returns:

The cleaned tag name

Throws:

Exception