更改：更改报告

注意：这个目标应该用作 Maven 报告。

全名：

org.apache.maven.plugins:maven-changes-plugin:2.4:changes-report

说明：

目标是从 changes.xml 文件中创建格式良好的 html 格式的更改报告。

属性：

  • 需要执行 Maven 2.0 项目。
  • 目标是线程安全的并支持并行构建。

可选参数

姓名 类型 自从 描述
addActionDate boolean 2.1 报告是否还应包括单个操作的日期的标志。如果设置为false，则仅将发布日期写入报告。
默认值为：false。
转义HTML boolean 2.4 已弃用。在 CDATA 部分中使用标记不适用于所有输出格式！
默认值为：true。
过滤更改 boolean 2.2 应用过滤过滤“a la”资源插件
默认值为：false。
问题链接模板 String 2.0-beta-2 已弃用。从 2.1 开始使用 issueLinkTemplatePerSystem ：这将是系统默认
值 默认值为: %URL%/ViewIssue.jspa?key=%ISSUE%。
issueLinkTemplatePerSystem Map 2.1 每个系统的模板字符串，用于发现用于显示问题报告的 URL。此映射中的每个键表示问题跟踪系统的（不区分大小写）标识符，其值给出 URL 模板。

您可以使用 2 个模板令牌。%URL%：这是通过 <issueManagement>/<url>从 POM 中获取值并删除最后一个 '/' 以及它之后的所有内容来计算的。 %ISSUE%: 这是问题编号。

注意：已弃用的 issueLinkTemplate 将用于称为“默认”的系统。

注意：从版本 2.4 开始，您通常不需要指定这一点，除非您需要在更改报告中链接到不支持开箱即用的问题管理系统。有关更多信息，请参阅使用页面。
输出目录 File - 报告输出目录。请注意，仅当目标从命令行或默认构建生命周期运行时，此参数才相关。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。
默认值为：${project.reporting.outputDirectory}。
输出编码 String 2.4 报告输出编码。请注意，仅当目标从命令行或默认构建生命周期运行时，此参数才相关。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出编码。
默认值为：${project.reporting.outputEncoding}。
发布日期格式 String 2.2 用于发布日期的格式。该值可通过以下表达式获得 ${publishDate}
默认值为: yyyy-MM-dd。
发布日期区域设置 String 2.2 格式化时用于 publishDate 的语言环境
默认值为: en。
团队列表 String 2.4 包含所有团队成员的文件的 URI。如果将其设置为特殊值“none”，则不会为团队成员生成链接。
默认值为：team-list.html。
xml路径 File - changes.xml将被转换为 HTML 报告的文件的路径。
默认值为：src/changes/changes.xml。

参数详情

添加操作日期：

报告是否还应包括单个操作的日期的标志。如果设置为false，则仅将发布日期写入报告。
  • 类型：boolean
  • 自：2.1
  • 必需：No
  • 表达式：${changes.addActionDate}
  • 默认：false

转义HTML：

已弃用。在 CDATA 部分中使用标记不适用于所有输出格式！
是否应转义动作中的 HTML 代码。通过将其更改为false您可以恢复此插件版本 2.2 中的行为，允许您使用 HTML 代码来格式化操作的内容。

注意：如果您在操作中使用 HTML 代码，则需要将其放在 CDATA 部分中。

注意：changes.xml如果您不小心，在 CDATA 部分中放置任何类型的标记都可能会弄乱基于您的文件的更改报告或其他生成的文档，例如 PDF 。
  • 类型：boolean
  • 自：2.4
  • 必需：No
  • 默认：true

过滤变化：

应用过滤过滤“a la”资源插件
  • 类型：boolean
  • 自：2.2
  • 必需：No
  • 默认：false

问题链接模板：

已弃用。从 2.1 开始使用 issueLinkTemplatePerSystem ：这将是系统默认值
用于发现用于显示问题报告的 URL 的模板字符串。您可以使用 2 个模板令牌。 %URL%：这是通过 <issueManagement>/<url>从 POM 中获取值并删除最后一个 '/' 以及它之后的所有内容来计算的。 %ISSUE%: 这是问题编号。

注意：在 2.0-beta-2 之前的这个插件版本中，这个参数被称为 link_template.

  • 类型：java.lang.String
  • 自：2.0-beta-2
  • 必需：No
  • 表达式：${changes.issueLinkTemplate}
  • 默认：%URL%/ViewIssue.jspa?key=%ISSUE%

issueLinkTemplatePerSystem：

每个系统的模板字符串，用于发现用于显示问题报告的 URL。此映射中的每个键表示问题跟踪系统的（不区分大小写）标识符，其值给出 URL 模板。

您可以使用 2 个模板令牌。%URL%：这是通过 <issueManagement>/<url>从 POM 中获取值并删除最后一个 '/' 以及它之后的所有内容来计算的。 %ISSUE%: 这是问题编号。

注意：已弃用的 issueLinkTemplate 将用于称为“默认”的系统。

注意：从版本 2.4 开始，您通常不需要指定这一点，除非您需要在更改报告中链接到不支持开箱即用的问题管理系统。有关更多信息，请参阅使用页面。

  • 类型：java.util.Map
  • 自：2.1
  • 必需：No

输出目录：

报告输出目录。请注意，仅当目标从命令行或默认构建生命周期运行时，此参数才相关。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出目录。
  • 类型：java.io.File
  • 必需：No
  • 默认：${project.reporting.outputDirectory}

输出编码：

报告输出编码。请注意，仅当目标从命令行或默认构建生命周期运行时，此参数才相关。如果目标作为站点生成的一部分间接运行，则使用在 Maven 站点插件中配置的输出编码。
  • 类型：java.lang.String
  • 自：2.4
  • 必需：No
  • 表达式：${outputEncoding}
  • 默认：${project.reporting.outputEncoding}

发布日期格式：

用于发布日期的格式。该值将通过以下表达式 ${publishDate} 可用
  • 类型：java.lang.String
  • 自：2.2
  • 必需：No
  • 默认：yyyy-MM-dd

发布日期区域设置：

格式化时用于 publishDate 的语言环境
  • 类型：java.lang.String
  • 自：2.2
  • 必需：No
  • 默认：en

团队名单：

包含所有团队成员的文件的 URI。如果将其设置为特殊值“none”，则不会为团队成员生成链接。
  • 类型：java.lang.String
  • 自：2.4
  • 必需：No
  • 默认：team-list.html

xml路径：

changes.xml将被转换为 HTML 报告的文件的路径。
  • 类型：java.io.File
  • 必需：No
  • 表达式：${changes.xmlPath}
  • 默认：src/changes/changes.xml