org.apache.maven.plugins.site
Class SiteDescriptorAttachMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.maven.plugins.site.AbstractSiteMojo
          org.apache.maven.plugins.site.SiteDescriptorAttachMojo

All Implemented Interfaces:

ContextEnabled, Mojo

@Mojo(name="attach-descriptor",
      defaultPhase=PACKAGE,
      threadSafe=true)
public class SiteDescriptorAttachMojo
extends AbstractSiteMojo

Adds the site descriptor (site.xml) to the list of files to be installed/deployed.
For Maven-2.x this is enabled by default only when the project has pom packaging since it will be used by modules inheriting, but this can be enabled for other projects packaging if needed.
This default execution has been removed from the built-in lifecycle of Maven 3.x for pom-projects. Users that actually use those projects to provide a common site descriptor for sub modules will need to explicitly define this goal execution to restore the intended behavior.

Version:

$Id: SiteDescriptorAttachMojo.html 861484 2013-05-09 23:10:16Z hboutemy $

Author:

Brett Porter

SiteDescriptorAttachMojo

public SiteDescriptorAttachMojo()

execute

public void execute()
             throws MojoExecutionException

Throws:

MojoExecutionException