更改:公告生成

全名:

org.apache.maven.plugins:maven-changes-plugin:2.3:announcement-generate

说明:

生成公告模板的目标。

属性:

  • 需要执行 Maven 2.0 项目。
  • 需要范围内工件的依赖关系解析:test.
  • 自版本:2.3.

必需参数

姓名 类型 自从 描述
基于的 String 2.1 当前项目基目录。
开发团队 String 2.3 开发工件的团队的名称。此参数将传递给模板。
默认值为:${project.name} team。
最终名称 String 2.3 要在公告中使用的工件的名称。
默认值为:${project.build.finalName}。
生成Jira公告 boolean 2.3 标记以确定插件是否会生成 JIRA 公告。
默认值为:false。
最大条目 int 2.3 从 JIRA 获取的最大问题数。

注意:在 2.0-beta-3 及更早版本中,此参数称为“nbEntries”。


默认值为:25。
输出目录 File 2.3 将生成模板文件的目录。
模板 String 2.3 用于格式化公告的 Velocity 模板。
默认值为:announcement.vm。
模板目录 String 2.3 包含模板的目录。

注意:此目录必须是 /src/main/resources/ or current project base directory.


默认值为:org/apache/maven/plugin/announcement。
版本 String 2.3 工件的版本。
默认值为:${project.version}。
xml路径 File 2.3 changes.xml 文件的路径。

可选参数

姓名 类型 自从 描述
宣布参数 Map 2.1 公告的自定义参数映射。此 Map 将传递给模板。
介绍 String 2.3 发布的工件的简短描述或介绍。此参数将传递给模板。
默认值为:${project.description}。
吉拉合并 boolean 2.1 如果来自 JIRA 的版本应该与来自 changes.xml 文件的版本合并。
默认值为:false。
jira密码 String 2.1 定义用于在私有 JIRA 安装中进行身份验证的 JIRA 密码。
吉拉用户 String 2.1 定义 JIRA 用户名,用于在私有 JIRA 安装中进行身份验证。
分辨率ID String 2.3 将来自 JIRA 的问题包含在这些解决方案 ID 中。多个分辨率 id 可以指定为逗号分隔的 id 列表。

注意:在 2.0-beta-3 及更早版本中,此参数称为“resolutionId”。


默认值为:Fixed。
runOnlyAtExecutionRoot boolean 2.3 这将导致执行仅在给定模块树的顶部运行。也就是说,在启动 mvn 执行的同一文件夹中包含的项目中运行。
默认值为:false。
状态标识 String 2.3 将来自 JIRA 的问题包含在这些状态 ID 中。可以将多个状态 ID 指定为逗号分隔的 ID 列表。

注意:在 2.0-beta-3 及更早版本中,此参数称为“statusId”。


默认值为:Closed。
模板编码 String 2.1 模板编码。
默认值为:${project.build.sourceEncoding}。
网址 String 2.3 工件的分发 URL。此参数将传递给模板。
网址下载 String 2.3 可以下载工件的 URL。如果未指定,则不使用 URL。此参数将传递给模板。

参数详情

宣布参数:

公告的自定义参数映射。此 Map 将传递给模板。
  • 类型:java.util.Map
  • 自:2.1
  • 必需:No

基于:

当前项目基目录。
  • 类型:java.lang.String
  • 自:2.1
  • 必需:Yes
  • 表达式:${basedir}

开发团队:

开发工件的团队的名称。此参数将传递给模板。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:Yes
  • 表达式:${changes.developmentTeam}
  • 默认:${project.name} team

最终名称:

要在公告中使用的工件的名称。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:Yes
  • 表达式:${changes.finalName}
  • 默认:${project.build.finalName}

生成Jira公告:

标记以确定插件是否会生成 JIRA 公告。
  • 类型:boolean
  • 自:2.3
  • 必需:Yes
  • 表达式:${generateJiraAnnouncement}
  • 默认:false

简介:

发布的工件的简短描述或介绍。此参数将传递给模板。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:No
  • 默认:${project.description}

吉拉合并:

如果来自 JIRA 的版本应该与来自 changes.xml 文件的版本合并。
  • 类型:boolean
  • 自:2.1
  • 必需:No
  • 表达式:${changes.jiraMerge}
  • 默认:false

吉拉密码:

定义用于在私有 JIRA 安装中进行身份验证的 JIRA 密码。
  • 类型:java.lang.String
  • 自:2.1
  • 必需:No
  • 表达式:${changes.jiraPassword}

吉拉用户:

定义 JIRA 用户名,用于在私有 JIRA 安装中进行身份验证。
  • 类型:java.lang.String
  • 自:2.1
  • 必需:No
  • 表达式:${changes.jiraUser}

最大条目:

从 JIRA 获取的最大问题数。

注意:在 2.0-beta-3 及更早版本中,此参数称为“nbEntries”。

  • 类型:int
  • 自:2.3
  • 必需:Yes
  • 表达式:${changes.maxEntries}
  • 默认:25

输出目录:

将生成模板文件的目录。
  • 类型:java.io.File
  • 自:2.3
  • 必需:Yes
  • 表达式:${project.build.directory}/announcement

分辨率标识:

将来自 JIRA 的问题包含在这些解决方案 ID 中。多个分辨率 id 可以指定为逗号分隔的 id 列表。

注意:在 2.0-beta-3 及更早版本中,此参数称为“resolutionId”。

  • 类型:java.lang.String
  • 自:2.3
  • 必需:No
  • 表达式:${changes.resolutionIds}
  • 默认:Fixed

runOnlyAtExecutionRoot:

这将导致执行仅在给定模块树的顶部运行。也就是说,在启动 mvn 执行的同一文件夹中包含的项目中运行。
  • 类型:boolean
  • 自:2.3
  • 必需:No
  • 表达式:${announcement.runOnlyAtExecutionRoot}
  • 默认:false

状态标识:

将来自 JIRA 的问题包含在这些状态 ID 中。可以将多个状态 ID 指定为逗号分隔的 ID 列表。

注意:在 2.0-beta-3 及更早版本中,此参数称为“statusId”。

  • 类型:java.lang.String
  • 自:2.3
  • 必需:No
  • 表达式:${changes.statusIds}
  • 默认:Closed

模板:

用于格式化公告的 Velocity 模板。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:Yes
  • 表达式:${changes.template}
  • 默认:announcement.vm

模板目录:

包含模板的目录。

注意:此目录必须是 /src/main/resources/ or current project base directory.

  • 类型:java.lang.String
  • 自:2.3
  • 必需:Yes
  • 表达式:${changes.templateDirectory}
  • 默认:org/apache/maven/plugin/announcement

模板编码:

模板编码。
  • 类型:java.lang.String
  • 自:2.1
  • 必需:No
  • 表达式:${changes.templateEncoding}
  • 默认:${project.build.sourceEncoding}

网址:

工件的分发 URL。此参数将传递给模板。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:No
  • 表达式:${project.url}

网址下载:

可以下载工件的 URL。如果未指定,则不使用 URL。此参数将传递给模板。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:No

版本:

工件的版本。
  • 类型:java.lang.String
  • 自:2.3
  • 必需:Yes
  • 表达式:${changes.version}
  • 默认:${project.version}

xml路径:

changes.xml 文件的路径。
  • 类型:java.io.File
  • 自:2.3
  • 必需:Yes
  • 表达式:${basedir}/src/changes/changes.xml