Built by Maven

site:stage-deploy

Full name:

org.apache.maven.plugins:maven-site-plugin:3.9.1:stage-deploy

Description:

Deploys the generated site to a staging or mock URL to the site URL specified in the <distributionManagement> section of the POM, using wagon supported protocols

Attributes:

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

Required Parameters

Name Type Since Description
<inputDirectory> File 2.3 Directory containing the generated project sites and report distributions.
Default value is: ${project.reporting.outputDirectory}.
Alias is: 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 value is: true.
User property is: 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 value is: g+w,a+rX.
User property is: maven.site.chmod.mode.
<chmodOptions> String 2.1 The options used by the "chmod" command. Only used if chmod = true. Defaults to "-Rf".
Default value is: -Rf.
User property is: 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 value is: en.
User property is: locales.
<skip> boolean 3.0 Set this to 'true' to skip site generation and staging.
Default value is: false.
User property is: maven.site.skip.
<skipDeploy> boolean 3.0 Set this to 'true' to skip site deployment.
Default value is: false.
User property is: maven.site.deploy.skip.
<stagingRepositoryId> String 2.0.1 The identifier of the repository where the staging site will be deployed. This id will be used to lookup a corresponding <server> entry from the settings.xml. If a matching <server> entry is found, its configured credentials will be used for authentication. If this is not specified, then the corresponding value of distributionManagement.site.id will be taken as default, unless this is not defined either then the String "stagingSite" is used. (Note: until v. 2.3 and 3.0-beta-3 the String "stagingSite" is always used.)
User property is: stagingRepositoryId.
<stagingSiteURL> String 2.3 The staged site will be deployed to this URL. If you don't specify this, the default-value will be "${project.distributionManagement.site.url}/staging", where "project" is either the current project or, in a reactor build, the top level project in the reactor.

Note that even if you specify this plugin parameter, you still need to indicate ${project.distributionManagement.site.url} at least in your top level project in order for relative links between modules to be resolved correctly.


User property is: stagingSiteURL.
<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 is: 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: en

<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

<stagingRepositoryId>

The identifier of the repository where the staging site will be deployed. This id will be used to lookup a corresponding <server> entry from the settings.xml. If a matching <server> entry is found, its configured credentials will be used for authentication. If this is not specified, then the corresponding value of distributionManagement.site.id will be taken as default, unless this is not defined either then the String "stagingSite" is used. (Note: until v. 2.3 and 3.0-beta-3 the String "stagingSite" is always used.)
  • Type: java.lang.String
  • Since: 2.0.1
  • Required: No
  • User Property: stagingRepositoryId

<stagingSiteURL>

The staged site will be deployed to this URL. If you don't specify this, the default-value will be "${project.distributionManagement.site.url}/staging", where "project" is either the current project or, in a reactor build, the top level project in the reactor.

Note that even if you specify this plugin parameter, you still need to indicate ${project.distributionManagement.site.url} at least in your top level project in order for relative links between modules to be resolved correctly.

  • Type: java.lang.String
  • Since: 2.3
  • Required: No
  • User Property: stagingSiteURL

<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