org.apache.maven.plugins.site
public class SiteStageMojo extends SiteMojo
<distributionManagement>
section of the
POM.
It can be used to test that links between module sites in a multi module build works.
Modifier and Type | Field and Description |
---|---|
protected static java.lang.String |
DEFAULT_STAGING_DIRECTORY |
protected java.io.File |
stagingDirectory
Staging directory location.
|
outputDirectory
artifactFactory, artifactResolver, assembler, attributes, generatedSiteDirectory, moduleExcludes, reports, repositories, siteRenderer
i18n, locales, localRepository, project, reactorProjects, siteDirectory, siteTool
Constructor and Description |
---|
SiteStageMojo() |
Modifier and Type | Method and Description |
---|---|
void |
execute()
Generate the project site
throws MojoExecutionException if any
|
protected java.io.File |
getStagingDirectory(org.apache.maven.project.MavenProject currentProject,
java.util.List reactorProjects,
java.io.File usersStagingDirectory)
Find the directory where staging will take place.
|
protected static java.lang.String |
getStructure(org.apache.maven.project.MavenProject project,
boolean ignoreMissingSiteUrl)
Generates the site structure using the project hiearchy (project and its modules) or using the
distributionManagement elements from the pom.xml.
|
protected org.apache.maven.project.MavenProject |
getTopLevelProject(java.util.List reactorProjects)
Find the top level parent in the reactor, i.e.
|
categoriseReports, createSiteRenderingContext, filterReports, locateDocuments, locateReports
getInputEncoding, getOutputEncoding, populateReportItems, toRelative
protected static final java.lang.String DEFAULT_STAGING_DIRECTORY
protected java.io.File stagingDirectory
C:\stagingArea\myProject\
on Windows or
/stagingArea/myProject/
on Unix.public void execute() throws org.apache.maven.plugin.MojoExecutionException, org.apache.maven.plugin.MojoFailureException
SiteMojo
protected java.io.File getStagingDirectory(org.apache.maven.project.MavenProject currentProject, java.util.List reactorProjects, java.io.File usersStagingDirectory)
currentProject
- The currently executing projectreactorProjects
- The projects in the reactorusersStagingDirectory
- The staging directory as suggested by the user's configurationprotected org.apache.maven.project.MavenProject getTopLevelProject(java.util.List reactorProjects)
reactorProjects
- The projects in the reactornull
if none can be foundprotected static java.lang.String getStructure(org.apache.maven.project.MavenProject project, boolean ignoreMissingSiteUrl) throws org.apache.maven.plugin.MojoFailureException
project
- ignoreMissingSiteUrl
- org.apache.maven.plugin.MojoFailureException
- if anyCopyright © 2014. All Rights Reserved.