site:deploy

Full name:

org.apache.maven.plugins:maven-site-plugin:2.2:deploy

Description:

Deploys the generated site using scp or file protocol to the site URL specified in the <distributionManagement> section of the POM.

For scp protocol, the website files are packaged into zip archive, then the archive is transfered to the remote host, next it is un-archived. This method of deployment should normally be much faster than making a file by file copy. For file protocol, the files are copied directly to the destination directory.

Attributes:

  • Requires a Maven 2.0 project to be executed.

Required Parameters

Name Type Since Description
inputDirectory File - 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.

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
  • Required: Yes
  • Expression: ${project.reporting.outputDirectory}