变更日志:开发活动

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

全名

org.apache.maven.plugins:maven-changelog-plugin:2.2:dev-activity

说明

生成开发人员活动报告。

属性

  • 需要执行 Maven 2.0 项目。

必需参数

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

可选参数

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

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

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


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

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

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


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

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

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


标题日期格式 String 2.1 用于指定用于报告标题中日期的格式。
默认值为yyyy-MM-dd
密码 String - 密码(由 java svn 使用)。
密码 String - 用户密码(由 svn 和 starteam 协议使用)。
私钥 String - 私钥(由 java svn 使用)。
范围 int - 用于指定要检索的日志条目的天数。
默认值为-1
网址 String - 查看 scm 的 URL。生成报告的外部链接的基础。
系统属性 Properties - 要使用的系统属性(perforce scm 提供程序需要)。
标签库 String - 标签基目录的 url(由 svn 协议使用)。
标签 List - 用于指定开始日志条目的标签(或标签列表)。
用户名 String - 用户名(由 svn 和 starteam 协议使用)。

参数详情

基于

输入目录。单片机控制的文件所在目录。
  • 类型java.io.File
  • 必需Yes
  • 表达式${basedir}

评论格式

用于询问修订控制系统的注释格式字符串。目前仅由 ClearcaseChangeLogGenerator 使用。
  • 类型java.lang.String
  • 必需No
  • 表达式${changelog.commentFormat}

连接类型

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

日期格式

用于指定从 SCM 系统检索的日志条目的日期格式。
  • 类型java.lang.String
  • 必需Yes
  • 表达式${changelog.dateFormat}
  • 默认yyyy-MM-dd HH:mm:ss

日期

用于指定开始日志条目的绝对日期(或日期列表)。
  • 类型java.util.List
  • 必需No

开发人员

要在报告中显示的开发人员列表。
  • 类型java.util.List
  • 2.2
  • 必需No
  • 表达式${project.developers}

displayChangeSetDetailUrl :

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

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

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

  • 类型java.lang.String
  • 2.2
  • 必需No
  • 表达式${displayChangeSetDetailUrl}

显示文件详细信息网址

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

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

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

  • 类型java.lang.String
  • 必需No
  • 表达式${displayFileDetailUrl}
  • 默认${project.scm.url}

displayFileRevDetailUrl :

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

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

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

  • 类型java.lang.String
  • 2.2
  • 必需No
  • 表达式${displayFileRevDetailUrl}

标题日期格式:

用于指定用于报告标题中日期的格式。
  • 类型java.lang.String
  • 2.1
  • 必需No
  • 表达式${changelog.headingDateFormat}
  • 默认yyyy-MM-dd

问题IDRegexPattern

一种用于识别“问题跟踪器”ID 的模式,例如 JIRA、Bugzilla 等在 SCM 提交消息中使用的 ID。任何匹配的模式都将替换为issueLinkUrlURL。默认值为 JIRA 风格的问题识别模式。
  • 类型java.lang.String
  • 2.2
  • 必需Yes
  • 表达式${issueIDRegexPattern}
  • 默认[a-zA-Z]{2,}-\d+

问题链接网址

替换 issueIDRegexPattern在 SCM 提交消息中找到的任何匹配项时使用的问题跟踪器 URL。默认的 URL 是 codehaus JIRA URL。如果在 URL 中找到 %ISSUE%,则将其替换为匹配的问题 ID,否则将匹配的问题 ID 附加到 URL。
  • 类型java.lang.String
  • 2.2
  • 必需Yes
  • 表达式${issueLinkUrl}
  • 默认http://jira.codehaus.org/browse/%ISSUE%

输出编码

xml 文档的输出编码
  • 类型java.lang.String
  • 必需Yes
  • 表达式${changelog.outputEncoding}
  • 默认ISO-8859-1

输出XML

xml文档的输出文件
  • 类型java.io.File
  • 必需Yes
  • 表达式${project.build.directory}/changelog.xml

输出XMLExpiration

允许用户在指定时间(以分钟为单位)使 changelog 重新生成 changelog.xml 文件。
  • 类型int
  • 必需Yes
  • 表达式${outputXMLExpiration}
  • 默认60

密码

密码(由 java svn 使用)。
  • 类型java.lang.String
  • 必需No
  • 表达式${passphrase}

密码

用户密码(由 svn 和 starteam 协议使用)。
  • 类型java.lang.String
  • 必需No
  • 表达式${password}

私钥

私钥(由 java svn 使用)。
  • 类型java.lang.String
  • 必需No
  • 表达式${privateKey}

范围

用于指定要检索的日志条目的天数。
  • 类型int
  • 必需No
  • 表达式${changelog.range}
  • 默认-1

scm网址

查看 scm 的 URL。生成报告的外部链接的基础。
  • 类型java.lang.String
  • 必需No
  • 表达式${project.scm.url}

系统属性

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

标签库

标签基目录的 url(由 svn 协议使用)。
  • 类型java.lang.String
  • 必需No
  • 表达式${tagBase}

标签

用于指定开始日志条目的标签(或标签列表)。
  • 类型java.util.List
  • 必需No

类型

用于指定是否使用范围、标签或日期构建日志。
  • 类型java.lang.String
  • 必需Yes
  • 表达式${changelog.type}
  • 默认range

用户名

用户名(由 svn 和 starteam 协议使用)。
  • 类型java.lang.String
  • 必需No
  • 表达式${username}