site:stage-deploy

Full name:

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

Description:

Deploys the generated site to a staging or mock directory to the site URL specified in the <distributionManagement> section of the POM. It supports scp and file protocols for deployment.

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.
skipDeploy boolean 3.0 Set this to 'true' to skip site deployment.
Default value is: false.
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.)
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.

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

skipDeploy:

Set this to 'true' to skip site deployment.
  • Type: boolean
  • Since: 3.0
  • Required: No
  • Expression: ${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
  • Expression: ${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
  • Expression: ${stagingSiteURL}