更改日志:文件活动

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

全名:

org.apache.maven.plugins:maven-changelog-plugin:2.3:file-activity

说明:

生成文件活动报告。

属性:

  • 需要执行一个 Maven 项目。

必需参数

姓名 类型 自从 描述
基于的 文件 - 输入目录。单片机控制的文件所在目录。
用户属性是:basedir。
连接类型 细绳 - 允许用户在连接到 scm 时选择使用哪个 scm 连接。可以是“连接”或“开发者连接”。
默认值为:连接。
日期格式 细绳 - 用于指定从 SCM 系统检索的日志条目的日期格式。
默认值为:yyyy-MM-dd HH:mm:ss。
用户属性是:changelog.dateFormat。
问题IDRegex模式 细绳 2.2 一种用于识别“问题跟踪器”ID 的模式,例如 JIRA、Bugzilla 等在 SCM 提交消息中使用的 ID。任何匹配的模式都将替换为issueLinkUrl URL。默认值为 JIRA 风格的问题识别模式。 注意:默认值为 [a-zA-Z]{2,}-\d+
默认值为:[a-zA-Z]{2,}-\d+。
用户属性是:issueIDRegexPattern。
问题链接网址 细绳 2.2 替换在 SCM 提交消息中找到的任何匹配的issueIDRegexPattern时使用的问题跟踪器 URL 。默认的 URL 是 codehaus JIRA URL。如果在 URL 中找到 %ISSUE%,则将其替换为匹配的问题 ID,否则将匹配的问题 ID 附加到 URL。
默认值为:http: //jira.codehaus.org/browse/%ISSUE%。
用户属性是:issueLinkUrl。
输出XML 文件 - xml 文档的输出文件
默认值为:${project.build.directory}/changelog.xml。
输出XMLExpiration 整数 - 允许用户在指定时间(以分钟为单位)使 changelog 重新生成 changelog.xml 文件。
默认值为:60。
用户属性是:outputXMLExpiration。
类型 细绳 - 用于指定是否使用范围、标签或日期构建日志。
默认值为:范围。
用户属性是:changelog.type。

可选参数

姓名 类型 自从 描述
评论格式 细绳 - 用于询问修订控制系统的注释格式字符串。目前仅由 ClearcaseChangeLogGenerator 使用。
用户属性是:changelog.commentFormat。
日期 列表 - 用于指定开始日志条目的绝对日期(或日期列表)。
开发商 列表 2.2 要在报告中显示的开发人员列表。
用户属性是:project.developers。
displayChangeSetDetailUrl 细绳 2.2 用于创建变更集 URL 的模板字符串。如果未定义,则不会创建更改集链接。您可以在模板中使用一种特殊标记:
  • %REV% - 这是变更集修订

示例: http: //fisheye.sourceforge.net/changelog/a-project/?cs=%REV%

注意:如果您没有在模板中提供 %REV% 标记,则修订将简单地附加到您的模板 URL。


用户属性是:displayChangeSetDetailUrl。
displayFileDetailUrl 细绳 - 用于创建文件详细信息的 URL 的模板字符串。您可以在模板中使用一个特殊的标记:
  • %FILE% - 这是文件的路径

示例: http ://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup

注意:如果您没有在模板中提供令牌,则文件的路径将简单地附加到您的模板 URL。


默认值为:${project.scm.url}。
用户属性是:displayFileDetailUrl。
displayFileRevDetailUrl 细绳 2.2 一个模板字符串,用于以与 displayFileDetailUrl类似的方式创建文件详细信息的修订感知 URL 。当报告同时包含文件和文件修订信息时,如在更改日志报告中,此模板字符串可用于创建文件详细信息的修订感知 URL。如果未定义此模板字符串,则默认为与displayFileDetailUrl相同的值,因此将不使用版本号感知链接。您可以在模板中使用两个特殊标记:
  • %FILE% - 这是文件的路径
  • %REV% - 这是文件的修订版本

示例: http: //fisheye.sourceforge.net/browse/a-project/%FILE%?r=%REV%

注意:如果您没有在模板中提供 %FILE% 标记,则文件的路径将简单地附加到您的模板 URL 中。


用户属性是:displayFileRevDetailUrl。
编码文件Uri 布尔值 2.3 对文件 uri 中的斜线进行编码。某些存储库浏览器(如 gitblit)需要
默认值:false。
用户属性是:encodeFileUri。
排除 细绳[] 2.3 要包含的文件列表。指定为要在报告中省略的文件的文件集模式
标题日期格式 细绳 2.1 用于指定用于报告标题中日期的格式。
默认值为:yyyy-MM-dd。
用户属性是:changelog.headingDateFormat。
包括 细绳[] 2.3 要包含的文件列表。指定为要包含在报告中的文件的文件集模式
输出编码 细绳 - 编写非 HTML 报告时的文件编码。
默认值为:${project.reporting.outputEncoding}。
用户属性是:changelog.outputEncoding。
密码 细绳 - 密码(由 java svn 使用)。
用户属性是:密码。
密码 细绳 - 用户密码(由 svn 和 starteam 协议使用)。
用户属性是:密码。
私钥 细绳 - 私钥(由 java svn 使用)。
用户属性是:privateKey。
提供者实现 地图 - 提供者实现列表。
范围 整数 - 用于指定要检索的日志条目的天数。
默认值为:-1。
用户属性是:changelog.range。
网址 细绳 - 查看 scm 的 URL。生成报告的外部链接的基础。
用户属性是:project.scm.url。
跳过 布尔值 2.3 跳过 Changelog 报告生成。通过“-Dchangelog.skip=true”在命令行上最有用。
默认值为:false。
用户属性是:changelog.skip。
系统属性 特性 - 要使用的系统属性(perforce scm 提供程序需要)。
标签库 细绳 - 标签基目录的 url(由 svn 协议使用)。
用户属性是:tagBase。
标签 列表 - 用于指定开始日志条目的标签(或标签列表)。
用户名 细绳 - 用户名(由 svn 和 starteam 协议使用)。
用户属性是:用户名。

参数详情

基于:

输入目录。单片机控制的文件所在目录。
  • 类型:java.io.File
  • 要求:是
  • 用户属性:basedir

评论格式:

用于询问修订控制系统的注释格式字符串。目前仅由 ClearcaseChangeLogGenerator 使用。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:changelog.commentFormat

连接类型:

允许用户在连接到 scm 时选择使用哪个 scm 连接。可以是“连接”或“开发者连接”。
  • 类型:java.lang.String
  • 要求:是
  • 默认:连接

日期格式:

用于指定从 SCM 系统检索的日志条目的日期格式。
  • 类型:java.lang.String
  • 要求:是
  • 用户属性:changelog.dateFormat
  • 默认值:yyyy-MM-dd HH:mm:ss

日期:

用于指定开始日志条目的绝对日期(或日期列表)。
  • 类型:java.util.List
  • 要求:否

开发人员:

要在报告中显示的开发人员列表。
  • 类型:java.util.List
  • 从: 2.2
  • 要求:否
  • 用户属性:project.developers

displayChangeSetDetailUrl :

用于创建变更集 URL 的模板字符串。如果未定义,则不会创建更改集链接。您可以在模板中使用一种特殊标记:
  • %REV% - 这是变更集修订

示例: http: //fisheye.sourceforge.net/changelog/a-project/?cs=%REV%

注意:如果您没有在模板中提供 %REV% 标记,则修订将简单地附加到您的模板 URL。

  • 类型:java.lang.String
  • 从: 2.2
  • 要求:否
  • 用户属性:displayChangeSetDetailUrl

显示文件详细信息网址:

用于创建文件详细信息的 URL 的模板字符串。您可以在模板中使用一个特殊的标记:
  • %FILE% - 这是文件的路径

示例: http ://checkstyle.cvs.sourceforge.net/checkstyle%FILE%?view=markup

注意:如果您没有在模板中提供令牌,则文件的路径将简单地附加到您的模板 URL。

  • 类型:java.lang.String
  • 要求:否
  • 用户属性:displayFileDetailUrl
  • 默认值:${project.scm.url}

displayFileRevDetailUrl :

一个模板字符串,用于以与 displayFileDetailUrl类似的方式创建文件详细信息的修订感知 URL 。当报告同时包含文件和文件修订信息时,如在更改日志报告中,此模板字符串可用于创建文件详细信息的修订感知 URL。如果未定义此模板字符串,则默认为与displayFileDetailUrl相同的值,因此将不使用版本号感知链接。您可以在模板中使用两个特殊标记:
  • %FILE% - 这是文件的路径
  • %REV% - 这是文件的修订版本

示例: http: //fisheye.sourceforge.net/browse/a-project/%FILE%?r=%REV%

注意:如果您没有在模板中提供 %FILE% 标记,则文件的路径将简单地附加到您的模板 URL 中。

  • 类型:java.lang.String
  • 从: 2.2
  • 要求:否
  • 用户属性:displayFileRevDetailUrl

编码文件Uri:

对文件 uri 中的斜线进行编码。某些存储库浏览器(如 gitblit)需要
  • 类型:布尔值
  • 从: 2.3
  • 要求:否
  • 用户属性:encodeFileUri
  • 默认值:假

不包括:

要包含的文件列表。指定为要在报告中省略的文件的文件集模式
  • 类型:java.lang.String[]
  • 从: 2.3
  • 要求:否

标题日期格式:

用于指定用于报告标题中日期的格式。
  • 类型:java.lang.String
  • 从: 2.1
  • 要求:否
  • 用户属性:changelog.headingDateFormat
  • 默认值:yyyy-MM-dd

包括:

要包含的文件列表。指定为要包含在报告中的文件的文件集模式
  • 类型:java.lang.String[]
  • 从: 2.3
  • 要求:否

问题IDRegexPattern:

一种用于识别“问题跟踪器”ID 的模式,例如 JIRA、Bugzilla 等在 SCM 提交消息中使用的 ID。任何匹配的模式都将替换为issueLinkUrl URL。默认值为 JIRA 风格的问题识别模式。 注意:默认值为 [a-zA-Z]{2,}-\d+
  • 类型:java.lang.String
  • 从: 2.2
  • 要求:是
  • 用户属性:问题IDRegexPattern
  • 默认值:[a-zA-Z]{2,}-\d+

问题链接网址:

替换在 SCM 提交消息中找到的任何匹配的issueIDRegexPattern时使用的问题跟踪器 URL 。默认的 URL 是 codehaus JIRA URL。如果在 URL 中找到 %ISSUE%,则将其替换为匹配的问题 ID,否则将匹配的问题 ID 附加到 URL。
  • 类型:java.lang.String
  • 从: 2.2
  • 要求:是
  • 用户属性:issueLinkUrl
  • 默认:http: //jira.codehaus.org/browse/%ISSUE%

输出编码:

编写非 HTML 报告时的文件编码。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:changelog.outputEncoding
  • 默认值:${project.reporting.outputEncoding}

输出XML:

xml文档的输出文件
  • 类型:java.io.File
  • 要求:是
  • 默认值:${project.build.directory}/changelog.xml

输出XMLExpiration:

允许用户在指定时间(以分钟为单位)使 changelog 重新生成 changelog.xml 文件。
  • 类型:整数
  • 要求:是
  • 用户属性:outputXMLExpiration
  • 默认值:60

密码:

密码(由 java svn 使用)。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:密码

密码:

用户密码(由 svn 和 starteam 协议使用)。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:密码

私钥:

私钥(由 java svn 使用)。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:privateKey

提供者实现:

提供者实现列表。
  • 类型:java.util.Map
  • 要求:否

范围:

用于指定要检索的日志条目的天数。
  • 类型:整数
  • 要求:否
  • 用户属性:changelog.range
  • 默认值:-1

scm网址:

查看 scm 的 URL。生成报告的外部链接的基础。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:project.scm.url

跳过:

跳过 Changelog 报告生成。通过“-Dchangelog.skip=true”在命令行上最有用。
  • 类型:布尔值
  • 从: 2.3
  • 要求:否
  • 用户属性:changelog.skip
  • 默认值:假

系统属性:

要使用的系统属性(perforce scm 提供程序需要)。
  • 类型:java.util.Properties
  • 要求:否

标签库:

标签基目录的 url(由 svn 协议使用)。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:tagBase

标签:

用于指定开始日志条目的标签(或标签列表)。
  • 类型:java.util.List
  • 要求:否

类型:

用于指定是否使用范围、标签或日期构建日志。
  • 类型:java.lang.String
  • 要求:是
  • 用户属性:changelog.type
  • 默认值:范围

用户名:

用户名(由 svn 和 starteam 协议使用)。
  • 类型:java.lang.String
  • 要求:否
  • 用户属性:用户名