site:deploy
Full name:
org.apache.maven.plugins:maven-site-plugin:4.0.0-M7:deploy
Description:
Deploys the generated site using wagon supported protocols to the site URL specified in the
<distributionManagement>
section of the POM.
For scp
protocol, the website files are packaged by wagon into zip archive, then the archive is transfered to the remote host, next it is un-archived which is much faster than making a file by file copy.
Attributes:
- Requires a Maven project to be executed.
- 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 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: default .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 . |
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