Built by Maven

site:stage

Full name:

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

Description:

Deploys the generated site to 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 work.

This goal requires the site to already have been generated using the site goal, such as by calling mvn site.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: test.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Required Parameters

Name Type Since Description
<inputDirectory> File 2.3 Directory containing the generated project sites and report distributions.
Default: ${project.reporting.outputDirectory}
Alias: outputDirectory

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: true
User Property: maven.site.chmod
<chmodMode> String 2.1 The mode used by the "chmod" command. Only used if chmod = true. Defaults to "g+w,a+rX".
Default: g+w,a+rX
User Property: maven.site.chmod.mode
<chmodOptions> String 2.1 The options used by the "chmod" command. Only used if chmod = true. Defaults to "-Rf".
Default: -Rf
User Property: maven.site.chmod.options
<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: default
User Property: locales
<skip> boolean 3.0 Set this to 'true' to skip site generation and staging.
Default: false
User Property: maven.site.skip
<skipDeploy> boolean 3.0 Set this to 'true' to skip site deployment.
Default: false
User Property: maven.site.deploy.skip
<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.
User Property: stagingDirectory
<topSiteURL> String 3.3 Top distribution management site url, for manual configuration when auto-calculated value doesn't match expectations. Relative module directory will be calculated from this url.
User Property: topSiteURL

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
  • User Property: 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
  • User Property: 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
  • User Property: 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
  • Default: ${project.reporting.outputDirectory}
  • Alias: outputDirectory

<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

<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

<skipDeploy>

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

<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
  • User Property: stagingDirectory

<topSiteURL>

Top distribution management site url, for manual configuration when auto-calculated value doesn't match expectations. Relative module directory will be calculated from this url.
  • Type: java.lang.String
  • Since: 3.3
  • Required: No
  • User Property: topSiteURL