site:attach-descriptor

Full name:

org.apache.maven.plugins:maven-site-plugin:4.0.0-M10:attach-descriptor

Description:

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.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 2.0.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
<locales> String 2.3 A comma separated list of locales to render. The first valid token will be the default Locale for this site.
Default value is: default.
User property is: locales.
<pomPackagingOnly> boolean 3.0 Attach site descriptor only if packaging is pom.
Default value is: true.
<relativizeSiteLinks> boolean 2.3 Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url.

Links will not be changed if this is set to false, or if the project has no URL defined.
Default value is: true.
User property is: relativizeSiteLinks.
<siteDirectory> File 2.3 Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).
Default value is: ${basedir}/src/site.
<skip> boolean 3.0 Set this to 'true' to skip site generation and staging.
Default value is: false.
User property is: maven.site.skip.

Parameter Details

<locales>

A comma separated list of locales to render. The first valid token will be the default Locale for this site.
  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • User Property: locales
  • Default: default

<pomPackagingOnly>

Attach site descriptor only if packaging is pom.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Default: true

<relativizeSiteLinks>

Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url.

Links will not be changed if this is set to false, or if the project has no URL defined.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: relativizeSiteLinks
  • Default: true

<siteDirectory>

Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).
  • Type: java.io.File
  • Since: 2.3
  • Required: No
  • Default: ${basedir}/src/site

<skip>

Set this to 'true' to skip site generation and staging.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • User Property: maven.site.skip
  • Default: false