更改:更改报告

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

全名

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

说明

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

属性

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

可选参数

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

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

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

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


输出目录 文件 - 报告输出目录。请注意,仅当目标从命令行或默认构建生命周期运行时,此参数才相关。如果目标作为站点生成的一部分间接运行,则使用在 Maven 站点插件中配置的输出目录。
默认值为${project.reporting.outputDirectory}
输出编码 细绳 2.4 报告输出编码。请注意,仅当目标从命令行或默认构建生命周期运行时,此参数才相关。如果目标作为站点生成的一部分间接运行,则使用在 Maven 站点插件中配置的输出编码。
默认值为${project.reporting.outputEncoding}
用户属性是outputEncoding
发布日期格式 细绳 2.2 用于发布日期的格式。该值将通过以下表达式可用 ${publishDate}
默认值为yyyy-MM-dd
发布日期区域设置 细绳 2.2 格式化时用于 publishDate 的语言环境
默认值为en
团队列表 细绳 2.4 包含所有团队成员的文件的 URI。如果将其设置为特殊值“none”,则不会为团队成员生成链接。
默认值为team-list.html
xml路径 文件 - 将转换为 HTML 报告的changes.xml文件的路径。
默认值为src/changes/changes.xml
用户属性是changes.xmlPath

参数详情

添加操作日期:

报告是否还应包括单个操作的日期的标志。如果设置为false,则仅将发布日期写入报告。
  • 类型布尔值
  • : 2.1
  • 要求
  • 用户属性changes.addActionDate
  • 默认值

汇总

报告是否还应包括来自子模块的更改的标志。如果设置为false,则仅将当前项目的更改写入报告。
  • 类型布尔值
  • : 2.5
  • 要求
  • 默认值

转义HTML

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

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

注意:如果您不小心,将任何类型的标记放在 CDATA 部分中可能会弄乱基于您的 changes.xml文件的更改报告或其他生成的文档(例如 PDF)。
  • 类型布尔值
  • : 2.4
  • 要求
  • 默认值

过滤变化

应用过滤过滤“a la”资源插件
  • 类型布尔值
  • : 2.2
  • 要求
  • 默认值

问题链接模板

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

注意:在此插件 2.0-beta-2 之前的版本中,此参数称为 link_template

  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 用户属性changes.issueLinkTemplate
  • 默认值%URL%/ViewIssue.jspa?key=%ISSUE%

issueLinkTemplatePerSystem

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

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

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

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

  • 类型java.util.Map
  • : 2.1
  • 要求

输出目录

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

输出编码

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

发布日期格式

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

发布日期区域设置

格式化时用于 publishDate 的语言环境
  • 类型java.lang.String
  • : 2.2
  • 要求
  • 默认值en

团队名单

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

xml路径

将转换为 HTML 报告的changes.xml文件的路径。
  • 类型java.io.File
  • 要求
  • 用户属性changes.xmlPath
  • 默认src/changes/changes.xml