Full name:
org.apache.maven.plugins:maven-site-plugin:3.3:stage-deploy
Description:
Attributes:
Name | Type | Since | Description |
---|---|---|---|
inputDirectory | File | 3.3 | Directory containing the generated project sites and report
distributions. Default value is: ${project.reporting.outputDirectory}. |
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. |
inputEncoding | String | 3.3 | Specifies the input encoding. Default value is: ${project.build.sourceEncoding}. User property is: encoding. |
locales | String | 3.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. User property is: locales. |
outputEncoding | String | 3.3 | Specifies the output encoding. Default value is: ${project.reporting.outputEncoding}. User property is: outputEncoding. |
siteDirectory | File | 3.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. 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 | 3.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. |
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.