site:attach-descriptor

Full name:

org.apache.maven.plugins:maven-site-plugin:3.0:attach-descriptor

Description:

Adds the site descriptor (site.xml) to the list of files to be installed/deployed. By default, this is enabled 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.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Optional Parameters

Name Type Since Description
inputEncoding String - Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
locales String - A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
outputEncoding String - Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.
pomPackagingOnly boolean - (no description)
Default value is: true.
siteDirectory File - Directory containing the site.xml file and the source for apt, fml and xdoc docs.
Default value is: ${basedir}/src/site.

Parameter Details

inputEncoding:

Specifies the input encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

locales:

A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
  • Type: java.lang.String
  • Required: No
  • Expression: ${locales}

outputEncoding:

Specifies the output encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputEncoding}
  • Default: ${project.reporting.outputEncoding}

pomPackagingOnly:

(no description)
  • Type: boolean
  • Required: No
  • Default: true

siteDirectory:

Directory containing the site.xml file and the source for apt, fml and xdoc docs.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site