站点：阶段部署

全名：

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

说明：

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

属性：

  • 需要执行一个 Maven 项目。
  • 需要对范围内的工件进行依赖解析：test。
  • 自版本：2.3。

必需参数

姓名 类型 自从 描述
输入目录 文件 2.3 包含生成的项目站点和报告分发的目录。

可选参数

姓名 类型 自从 描述
修改 布尔值 2.1 部署后是否在远程站点上运行“chmod”命令。默认为“真”。
默认值为：true。
chmod模式 细绳 2.1 “chmod”命令使用的模式。仅在 chmod = true 时使用。默认为“g+w,a+rX”。
默认值为：g+w,a+rX。
chmod选项 细绳 2.1 “chmod”命令使用的选项。仅在 chmod = true 时使用。默认为“-Rf”。
默认值为：-Rf。
输入编码 细绳 2.3 指定输入编码。
默认值为：${project.build.sourceEncoding}。
语言环境 细绳 2.3 Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
输出编码 细绳 2.3 指定输出编码。
默认值为：${project.reporting.outputEncoding}。
站点目录 文件 2.3 包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。
默认值为：${basedir}/src/site。
stagingRepositoryId 细绳 2.0.1 将部署暂存站点的存储库的标识符。此 id 将用于 从settings.xml中查找相应的<server>条目 。如果找到匹配的 <server>条目，则其配置的凭据将用于身份验证。如果未指定，则将 distributionManagement.site.id的相应值作为默认值，除非也未定义，否则使用字符串 “stagingSite”。（注意：在 v. 2.3 和 3.0-beta-3之前，始终使用字符串“stagingSite” 。）
暂存站点URL 细绳 2.3 暂存站点将部署到此 URL。如果不指定，默认值将是“${project.distributionManagement.site.url}/staging”，其中“project”是当前项目，或者在 reactor 构建中是顶层项目反应堆。

请注意，即使您指定了此插件参数，您仍然需要至少在您的顶级项目中指明 ${project.distributionManagement.site.url} 以便正确解析模块之间的相对链接。

参数详情

chmod：

部署后是否在远程站点上运行“chmod”命令。默认为“真”。
  • 类型：布尔值
  • 从: 2.1
  • 要求：否
  • 表达式：${maven.site.chmod}
  • 默认值：真

chmod模式：

“chmod”命令使用的模式。仅在 chmod = true 时使用。默认为“g+w,a+rX”。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 表达式：${maven.site.chmod.mode}
  • 默认值：g+w,a+rX

chmod选项：

“chmod”命令使用的选项。仅在 chmod = true 时使用。默认为“-Rf”。
  • 类型：java.lang.String
  • 从: 2.1
  • 要求：否
  • 表达式：${maven.site.chmod.options}
  • 默认值：-Rf

输入目录：

包含生成的项目站点和报告分发的目录。
  • 类型：java.io.File
  • 从: 2.3
  • 要求：是
  • 表达式：${project.reporting.outputDirectory}

输入编码：

指定输入编码。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${编码}
  • 默认值：${project.build.sourceEncoding}

语言环境：

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${locales}

输出编码：

指定输出编码。
  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${outputEncoding}
  • 默认值：${project.reporting.outputEncoding}

站点目录：

包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。
  • 类型：java.io.File
  • 从: 2.3
  • 要求：否
  • 默认：${basedir}/src/site

stagingRepositoryId：

将部署暂存站点的存储库的标识符。此 id 将用于 从settings.xml中查找相应的<server>条目 。如果找到匹配的 <server>条目，则其配置的凭据将用于身份验证。如果未指定，则将 distributionManagement.site.id的相应值作为默认值，除非也未定义，否则使用字符串 “stagingSite”。（注意：在 v. 2.3 和 3.0-beta-3之前，始终使用字符串“stagingSite” 。）
  • 类型：java.lang.String
  • 自：2.0.1
  • 要求：否
  • 表达式：${stagingRepositoryId}

登台站点URL：

暂存站点将部署到此 URL。如果不指定，默认值将是“${project.distributionManagement.site.url}/staging”，其中“project”是当前项目，或者在 reactor 构建中是顶层项目反应堆。

请注意，即使您指定了此插件参数，您仍然需要至少在您的顶级项目中指明 ${project.distributionManagement.site.url} 以便正确解析模块之间的相对链接。

  • 类型：java.lang.String
  • 从: 2.3
  • 要求：否
  • 表达式：${stagingSiteURL}