站点：阶段部署

全名：

org.apache.maven.plugins:maven-site-plugin:2.0.1:stage-deploy

说明：

<distributionManagement>将生成的站点部署到POM 部分中指定的站点 URL 的登台或模拟目录 。它支持scp部署file协议。

属性：

  • 需要执行 Maven 2.0 项目。
  • 需要范围内工件的依赖关系解析：test.

必需参数

姓名 类型 自从 描述
生成的站点目录 File - 包含生成文档的目录。
输出目录 File - 包含生成的项目站点和报告分发的目录。
默认值为：${project.reporting.outputDirectory}。
站点目录 File - 包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。

可选参数

姓名 类型 自从 描述
属性 Map - 用于呈现站点的模板属性。
生成报告 boolean - 允许您禁用报告生成的便利参数。
默认值为：true。
输入编码 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 和图像被禁用。强烈建议您将其打包为皮肤。
xdoc目录 File - xdoc 源的替代目录，对 m1 到 m2 迁移很有用
默认值是: ${basedir}/xdocs。

参数详情

属性：

用于呈现站点的模板属性。
  • 类型：java.util.Map
  • 必需：No
  • 表达式：${attributes}

生成报告：

允许您禁用报告生成的便利参数。
  • 类型：boolean
  • 必需：No
  • 表达式：${generateReports}
  • 默认：true

生成站点目录：

包含生成文档的目录。
  • 类型：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}

语言环境：

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
  • 类型：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}

站点目录：

包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。
  • 类型：java.io.File
  • 必需：Yes
  • 表达式：${basedir}/src/site

暂存目录：

暂存目录位置。这需要是绝对路径，例如 C:\stagingArea\myProject\在 Windows 或 /stagingArea/myProject/Unix 上。
  • 类型：java.io.File
  • 必需：No
  • 表达式：${stagingDirectory}

stagingRepositoryId：

将部署暂存站点的存储库的标识符。此 id 将用于 <server>从 settings.xml. 如果找到匹配的 <server>条目，则其配置的凭据将用于身份验证。
  • 类型：java.lang.String
  • 自：2.0.1
  • 必需：No
  • 表达式：${stagingRepositoryId}
  • 默认：stagingSite

登台站点URL：

暂存站点将部署到此 URL。如果不指定，默认值将是“${project.distributionManagement.site.url}/staging”，其中“project”是当前项目，或者在 reactor 构建中是顶层项目反应堆。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${stagingSiteURL}

模板：

已弃用。改用 templateFile 或蒙皮
默认模板页面。
  • 类型：java.lang.String
  • 必需：No
  • 表达式：${template}

模板目录：

已弃用。改用 templateFile 或蒙皮
包含模板页面的目录。
  • 类型：java.io.File
  • 必需：No
  • 表达式：${templateDirectory}
  • 默认：src/site

模板文件：

要使用的 Velocity 模板文件的位置。使用时，皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。
  • 类型：java.io.File
  • 自：2.0-beta-5
  • 必需：No
  • 表达式：${templateFile}

xdoc目录：

xdoc 源的替代目录，对 m1 到 m2 迁移很有用
  • 类型：java.io.File
  • 必需：No
  • 默认：${basedir}/xdocs