Full name:
org.apache.maven.plugins:maven-site-plugin:2.1:stage-deploy
Description:
<distributionManagement>
section of the POM. It
supports scp
and file
protocols for
deployment.Attributes:
test
.Name | Type | Since | Description |
---|---|---|---|
generatedSiteDirectory | File |
- |
Directory containing generated documentation. |
outputDirectory | File |
- |
Directory containing the generated project sites and report
distributions. Default value is: ${project.reporting.outputDirectory} . |
siteDirectory | File |
- |
Directory containing the site.xml file and the source for apt, fml
and xdoc docs. |
Name | Type | Since | Description |
---|---|---|---|
attributes | Map |
- |
The template properties for rendering the site. |
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 . |
generateReports | boolean |
- |
Convenience parameter that allows you to disable report generation. Default value is: true . |
generateSitemap | boolean |
2.1 |
Generate a sitemap. The result will be a "sitemap.html" file at the
site root. Default value is: false . |
inputEncoding | String |
- |
Specifies the input encoding. Default value is: ${project.build.sourceEncoding} . |
localRepository | ArtifactRepository |
- |
The local repository. |
locales | String |
- |
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. |
moduleExcludes | Map |
- |
Module type exclusion mappings ex: fml ->
**/*-m1.fml (excludes fml files ending in '-m1.fml'
recursively)
The configuration looks like this:
<moduleExcludes> <moduleType>filename1.ext,**/*sample.ext</moduleType> <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. --> <!-- The value is a comma separated list of --> <!-- filenames or fileset patterns. --> <!-- Here's an example: --> <xdoc>changes.xml,navigation.xml</xdoc> </moduleExcludes> |
outputEncoding | String |
- |
Specifies the output encoding. Default value is: ${project.reporting.outputEncoding} . |
repositories | List |
- |
Remote repositories used for the project. |
stagingDirectory | File |
- |
Staging directory location. This needs to be an absolute path, like
C:\stagingArea\myProject\ on Windows or
/stagingArea/myProject/ on Unix. |
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.Default value is: stagingSite . |
stagingSiteURL | String |
- |
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. |
template | String |
- |
Deprecated. use templateFile or skinning instead |
templateDirectory | File |
- |
Deprecated. use templateFile or skinning instead Default value is: src/site . |
templateFile | File |
2.0-beta-5 |
The location of a Velocity template file to use. When used, skins
and the default templates, CSS and images are disabled. It is
highly recommended that you package this as a skin instead. |
xdocDirectory | File |
- |
Deprecated. use the standard m2 directory layout Default value is: ${basedir}/xdocs . |
java.util.Map
No
${attributes}
boolean
2.1
No
${maven.site.chmod}
true
java.lang.String
2.1
No
${maven.site.chmod.mode}
g+w,a+rX
java.lang.String
2.1
No
${maven.site.chmod.options}
-Rf
boolean
No
${generateReports}
true
boolean
2.1
No
${generateSitemap}
false
java.io.File
Yes
${project.build.directory}/generated-site
java.lang.String
No
${encoding}
${project.build.sourceEncoding}
org.apache.maven.artifact.repository.ArtifactRepository
No
${localRepository}
java.lang.String
No
${locales}
fml ->
**/*-m1.fml
(excludes fml files ending in '-m1.fml'
recursively)
The configuration looks like this:
<moduleExcludes> <moduleType>filename1.ext,**/*sample.ext</moduleType> <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. --> <!-- The value is a comma separated list of --> <!-- filenames or fileset patterns. --> <!-- Here's an example: --> <xdoc>changes.xml,navigation.xml</xdoc> </moduleExcludes>
java.util.Map
No
java.io.File
Yes
${siteOutputDirectory}
${project.reporting.outputDirectory}
java.lang.String
No
${outputEncoding}
${project.reporting.outputEncoding}
java.util.List
No
${project.remoteArtifactRepositories}
java.io.File
Yes
${basedir}/src/site
C:\stagingArea\myProject\
on Windows or
/stagingArea/myProject/
on Unix.java.io.File
No
${stagingDirectory}
<server>
entry from the
settings.xml
. If a matching
<server>
entry is found, its configured
credentials will be used for authentication.java.lang.String
2.0.1
No
${stagingRepositoryId}
stagingSite
java.lang.String
No
${stagingSiteURL}
java.lang.String
No
${template}
java.io.File
No
${templateDirectory}
src/site
java.io.File
2.0-beta-5
No
${templateFile}
java.io.File
No
${basedir}/xdocs