Class GenerateReleasePomsPhase

java.lang.Object

org.codehaus.plexus.logging.AbstractLogEnabled

org.apache.maven.shared.release.phase.AbstractReleasePhase

org.apache.maven.shared.release.phase.AbstractReleasePomsPhase

org.apache.maven.shared.release.phase.GenerateReleasePomsPhase

All Implemented Interfaces:

ReleasePhase, ResourceGenerator, org.codehaus.plexus.logging.LogEnabled

@Component(role=ReleasePhase.class,
           hint="generate-release-poms")
public class GenerateReleasePomsPhase
extends AbstractReleasePomsPhase
implements ResourceGenerator

Generate release POMs.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	FINALNAME_EXPRESSION
private org.apache.maven.model.interpolation.ModelInterpolator	modelInterpolator
private Map<String, ScmTranslator>	scmTranslators	SCM URL translators mapped by provider name.
private org.apache.maven.model.superpom.SuperPomProvider	superPomProvider

Constructor Summary

Constructors

Constructor	Description
GenerateReleasePomsPhase()

Method Summary

Modifier and Type	Method	Description
private void	addReleasePomsToScm(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects, boolean simulate, ReleaseResult result, List<File> releasePoms)
ReleaseResult	clean(List<org.apache.maven.project.MavenProject> reactorProjects)	Clean up after a phase if it leaves any additional files in the checkout.
private List<org.apache.maven.model.Dependency>	createReleaseDependencies(ReleaseDescriptor releaseDescriptor, org.apache.maven.project.MavenProject project)
private List<org.apache.maven.model.Extension>	createReleaseExtensions(ReleaseDescriptor releaseDescriptor, org.apache.maven.project.MavenProject project)
private org.apache.maven.model.Model	createReleaseModel(org.apache.maven.project.MavenProject project, ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects, ReleaseResult result)
private List<org.apache.maven.model.Plugin>	createReleasePlugins(ReleaseDescriptor releaseDescriptor, org.apache.maven.project.MavenProject project)
private List<org.apache.maven.model.ReportPlugin>	createReleaseReportPlugins(ReleaseDescriptor releaseDescriptor, org.apache.maven.project.MavenProject project)
private org.apache.maven.model.Scm	createReleaseScm(org.apache.maven.model.Scm scm, ScmTranslator scmTranslator, ReleaseDescriptor releaseDescriptor)
ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects)	Execute the phase.
private ReleaseResult	execute(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects, boolean simulate)
private String	findOriginalFinalName(org.apache.maven.project.MavenProject project)
private File	generateReleasePom(org.apache.maven.project.MavenProject project, ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects, boolean simulate, ReleaseResult result)
private void	generateReleasePoms(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects, boolean simulate, ReleaseResult result)
private String	getNextVersion(ReleaseDescriptor releaseDescriptor, String groupId, String artifactId, String version)
private String	getReleaseVersion(ReleaseDescriptor releaseDescriptor, org.apache.maven.artifact.Artifact artifact)
private ScmTranslator	getScmTranslator(org.apache.maven.scm.repository.ScmRepository scmRepository)
private String	resolvePath(Path basedir, String current, String superInterpolated, String superRaw)
private String	resolvePath(Path basedir, String current, Map<String,String> superValues)
ReleaseResult	simulate(ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, List<org.apache.maven.project.MavenProject> reactorProjects)	Simulate the phase, but don't make any changes to the project.
private void	unalignFromBaseDirectory(org.apache.maven.model.Model releaseModel, File basedir)

Methods inherited from class AbstractReleasePomsPhase

getScmProvider, getScmRepository

Methods inherited from class AbstractReleasePhase

getReleaseResultSuccess, logDebug, logDebug, logError, logInfo, logWarn

Methods inherited from class org.codehaus.plexus.logging.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FINALNAME_EXPRESSION

private static final String FINALNAME_EXPRESSION

See Also:

• Constant Field Values

superPomProvider

@Requirement
private org.apache.maven.model.superpom.SuperPomProvider superPomProvider

modelInterpolator

@Requirement
private org.apache.maven.model.interpolation.ModelInterpolator modelInterpolator

scmTranslators

@Requirement(role=ScmTranslator.class)
private Map<String, ScmTranslator> scmTranslators

SCM URL translators mapped by provider name.

Constructor Details

GenerateReleasePomsPhase

public GenerateReleasePomsPhase()

Method Details

execute

public ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects)
                      throws ReleaseExecutionException,
ReleaseFailureException

Description copied from interface: ReleasePhase

Execute the phase.

Specified by:

execute in interface ReleasePhase

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

execute

private ReleaseResult execute(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects,
 boolean simulate)
                       throws ReleaseExecutionException,
ReleaseFailureException

Throws:

ReleaseExecutionException

ReleaseFailureException

generateReleasePoms

private void generateReleasePoms(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects,
 boolean simulate,
 ReleaseResult result)
                          throws ReleaseExecutionException,
ReleaseFailureException

Throws:

ReleaseExecutionException

ReleaseFailureException

generateReleasePom

private File generateReleasePom(org.apache.maven.project.MavenProject project,
 ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects,
 boolean simulate,
 ReleaseResult result)
                         throws ReleaseExecutionException,
ReleaseFailureException

Throws:

ReleaseExecutionException

ReleaseFailureException

addReleasePomsToScm

private void addReleasePomsToScm(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects,
 boolean simulate,
 ReleaseResult result,
 List<File> releasePoms)
                          throws ReleaseFailureException,
ReleaseExecutionException

Throws:

ReleaseFailureException

ReleaseExecutionException

createReleaseModel

private org.apache.maven.model.Model createReleaseModel(org.apache.maven.project.MavenProject project,
 ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects,
 ReleaseResult result)
                                                 throws ReleaseFailureException,
ReleaseExecutionException

Throws:

ReleaseFailureException

ReleaseExecutionException

unalignFromBaseDirectory

private void unalignFromBaseDirectory(org.apache.maven.model.Model releaseModel,
 File basedir)

resolvePath

private String resolvePath(Path basedir,
 String current,
 String superInterpolated,
 String superRaw)

resolvePath

private String resolvePath(Path basedir,
 String current,
 Map<String,String> superValues)

findOriginalFinalName

private String findOriginalFinalName(org.apache.maven.project.MavenProject project)

simulate

public ReleaseResult simulate(ReleaseDescriptor releaseDescriptor,
 ReleaseEnvironment releaseEnvironment,
 List<org.apache.maven.project.MavenProject> reactorProjects)
                       throws ReleaseExecutionException,
ReleaseFailureException

Description copied from interface: ReleasePhase

Simulate the phase, but don't make any changes to the project.

Specified by:

simulate in interface ReleasePhase

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

getNextVersion

private String getNextVersion(ReleaseDescriptor releaseDescriptor,
 String groupId,
 String artifactId,
 String version)
                       throws ReleaseFailureException

Throws:

ReleaseFailureException

getScmTranslator

private ScmTranslator getScmTranslator(org.apache.maven.scm.repository.ScmRepository scmRepository)

createReleaseScm

private org.apache.maven.model.Scm createReleaseScm(org.apache.maven.model.Scm scm,
 ScmTranslator scmTranslator,
 ReleaseDescriptor releaseDescriptor)

createReleaseDependencies

private List<org.apache.maven.model.Dependency> createReleaseDependencies(ReleaseDescriptor releaseDescriptor,
 org.apache.maven.project.MavenProject project)
                                                                   throws ReleaseFailureException

Throws:

ReleaseFailureException

getReleaseVersion

private String getReleaseVersion(ReleaseDescriptor releaseDescriptor,
 org.apache.maven.artifact.Artifact artifact)
                          throws ReleaseFailureException

Throws:

ReleaseFailureException

createReleasePlugins

private List<org.apache.maven.model.Plugin> createReleasePlugins(ReleaseDescriptor releaseDescriptor,
 org.apache.maven.project.MavenProject project)
                                                          throws ReleaseFailureException

Throws:

ReleaseFailureException

createReleaseReportPlugins

private List<org.apache.maven.model.ReportPlugin> createReleaseReportPlugins(ReleaseDescriptor releaseDescriptor,
 org.apache.maven.project.MavenProject project)
                                                                      throws ReleaseFailureException

Throws:

ReleaseFailureException

createReleaseExtensions

private List<org.apache.maven.model.Extension> createReleaseExtensions(ReleaseDescriptor releaseDescriptor,
 org.apache.maven.project.MavenProject project)
                                                                throws ReleaseFailureException

Throws:

ReleaseFailureException

clean

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

Description copied from interface: ResourceGenerator

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

Specified by:

clean in interface ResourceGenerator

Parameters:

reactorProjects - the reactor projects

Returns:

the release result