全名:
org.apache.maven.plugins:maven-site-plugin:2.1.1:stage-deploy
说明:
<distributionManagement>
将生成的站点部署到POM 部分中指定的站点 URL 的登台或模拟目录
。它支持scp
部署file
协议。属性:
test
.姓名 | 类型 | 自从 | 描述 |
---|---|---|---|
生成的站点目录 | File |
- |
包含生成文档的目录。 |
输出目录 | File |
- |
包含生成的项目站点和报告分发的目录。 默认值为: ${project.reporting.outputDirectory} 。 |
站点目录 | File |
- |
包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。 |
姓名 | 类型 | 自从 | 描述 |
---|---|---|---|
属性 | Map |
- |
用于呈现站点的模板属性。 |
修改 | boolean |
2.1 |
部署后是否在远程站点上运行“chmod”命令。默认为“真”。 默认值为: true 。 |
chmod模式 | String |
2.1 |
“chmod”命令使用的模式。仅在 chmod = true 时使用。默认为“g+w,a+rX”。 默认值为: g+w,a+rX 。 |
chmod选项 | String |
2.1 |
“chmod”命令使用的选项。仅在 chmod = true 时使用。默认为“-Rf”。 默认值为: -Rf 。 |
生成报告 | boolean |
- |
允许您禁用报告生成的便利参数。 默认值为: true 。 |
生成站点地图 | boolean |
2.1 |
生成站点地图。结果将是站点根目录中的“sitemap.html”文件。 默认值为: false 。 |
输入编码 | String |
- |
指定输入编码。 默认值为: ${project.build.sourceEncoding} 。 |
本地存储库 | ArtifactRepository |
- |
本地存储库。 |
语言环境 | String |
- |
Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。 |
模块排除 | Map |
- |
模块类型排除映射例如:(fml ->
**/*-m1.fml 递归排除以“-m1.fml”结尾的 fml 文件)
配置如下所示:
<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> |
输出编码 | String |
- |
指定输出编码。 默认值为: ${project.reporting.outputEncoding} 。 |
存储库 | List |
- |
用于项目的远程存储库。 |
暂存目录 | File |
- |
暂存目录位置。这需要是绝对路径,例如
C:\stagingArea\myProject\ 在 Windows 或
/stagingArea/myProject/ Unix 上。 |
stagingRepositoryId | String |
2.0.1 |
将部署暂存站点的存储库的标识符。此 id 将用于
<server> 从
settings.xml . 如果找到匹配的
<server> 条目,则其配置的凭据将用于身份验证。默认值为: stagingSite 。 |
暂存站点URL | String |
- |
暂存站点将部署到此 URL。如果不指定,默认值将是“${project.distributionManagement.site.url}/staging”,其中“project”是当前项目,或者在 reactor 构建中是顶层项目反应堆。 |
模板 | String |
- |
已弃用。改用 templateFile 或蒙皮 |
模板目录 | File |
- |
已弃用。改用 templateFile 或 skinning 默认值为: src/site 。 |
模板文件 | File |
2.0-beta-5 |
要使用的 Velocity 模板文件的位置。使用时,皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。 |
证实 | boolean |
2.1.1 |
是否验证 xml 输入文档。如果设置为 true,
所有xml 格式的输入文档(特别是 xdoc 和 fml)都将被验证,任何错误都将导致构建失败。 默认值为: false 。 |
xdoc目录 | File |
- |
已弃用。使用标准 m2 目录布局 默认值为: ${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
递归排除以“-m1.fml”结尾的 fml 文件)
配置如下所示:
<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\
在 Windows 或
/stagingArea/myProject/
Unix 上。java.io.File
No
${stagingDirectory}
<server>
从
settings.xml
. 如果找到匹配的
<server>
条目,则其配置的凭据将用于身份验证。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}
验证:
boolean
2.1.1
No
${validate}
false
java.io.File
No
${basedir}/xdocs