site:stage

Full name:

org.apache.maven.plugins:maven-site-plugin:2.3:stage

Description:

Generates a site in a local staging or mock directory based on the site URL specified in the <distributionManagement> section of the POM.

It can be used to test that links between module sites in a multi module build works.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • Since version: 2.3.

Required Parameters

Name Type Since Description
inputDirectory File 2.3 Directory containing the generated project sites and report distributions.

Optional Parameters

Name Type Since Description
chmod boolean 2.1 Whether to run the "chmod" command on the remote site after the deploy. Defaults to "true".
Default value is: true.
chmodMode String 2.1 The mode used by the "chmod" command. Only used if chmod = true. Defaults to "g+w,a+rX".
Default value is: g+w,a+rX.
chmodOptions String 2.1 The options used by the "chmod" command. Only used if chmod = true. Defaults to "-Rf".
Default value is: -Rf.
inputEncoding String 2.3 Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
locales String 2.3 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 2.3 Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.
siteDirectory File 2.3 Directory containing the site.xml file and the source for apt, fml and xdoc docs.
Default value is: ${basedir}/src/site.
stagingDirectory File 2.3 Staging directory location. This needs to be an absolute path, like C:\stagingArea\myProject\ on Windows or /stagingArea/myProject/ on Unix. If this is not specified, the site will be staged in ${project.build.directory}/staging.

Parameter Details

chmod:

Whether to run the "chmod" command on the remote site after the deploy. Defaults to "true".
  • Type: boolean
  • Since: 2.1
  • Required: No
  • Expression: ${maven.site.chmod}
  • Default: true

chmodMode:

The mode used by the "chmod" command. Only used if chmod = true. Defaults to "g+w,a+rX".
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${maven.site.chmod.mode}
  • Default: g+w,a+rX

chmodOptions:

The options used by the "chmod" command. Only used if chmod = true. Defaults to "-Rf".
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • Expression: ${maven.site.chmod.options}
  • Default: -Rf

inputDirectory:

Directory containing the generated project sites and report distributions.
  • Type: java.io.File
  • Since: 2.3
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}

inputEncoding:

Specifies the input encoding.
  • Type: java.lang.String
  • Since: 2.3
  • 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
  • Since: 2.3
  • Required: No
  • Expression: ${locales}

outputEncoding:

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

siteDirectory:

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

stagingDirectory:

Staging directory location. This needs to be an absolute path, like C:\stagingArea\myProject\ on Windows or /stagingArea/myProject/ on Unix. If this is not specified, the site will be staged in ${project.build.directory}/staging.
  • Type: java.io.File
  • Since: 2.3
  • Required: No
  • Expression: ${stagingDirectory}