更改:公告生成

全名

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

说明

生成公告模板的目标。

属性

  • 需要执行一个 Maven 项目。
  • 需要对范围内的工件进行依赖解析:test
  • 目标是线程安全的并支持并行构建。
  • 自版本:2.0-beta-2

必需参数

姓名 类型 自从 描述
基于的 细绳 2.1 当前项目基目录。
开发团队 细绳 2.0-beta-2 开发工件的团队的名称。此参数将传递给模板。
默认值为${project.name} team
最终名称 细绳 2.0-beta-2 要在公告中使用的工件的名称。
默认值为${project.build.finalName}
生成Jira公告 布尔值 2.0-beta-2 已弃用。从 2.4 版开始,此参数已被弃用。请改用 issueManagementSystems 参数。
默认值为false
最大条目 整数 2.0-beta-2 从 JIRA 获取的最大问题数。

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


默认值为25
输出目录 文件 2.0-beta-2 将生成模板文件的目录。
模板 细绳 2.0-beta-2 用于格式化公告的 Velocity 模板。
默认值为announcement.vm
模板目录 细绳 2.0-beta-2 包含模板的目录。

注意:此目录必须是 /src/main/resources/ 或当前项目基目录的子目录。


默认值为org/apache/maven/plugin/announcement
版本 细绳 2.0-beta-2 工件的版本。
默认值为${project.version}
xml路径 文件 2.0-beta-2 changes.xml 文件的路径。

可选参数

姓名 类型 自从 描述
宣布参数 地图 2.1 公告的自定义参数映射。此 Map 将传递给模板。
公告文件 细绳 2.4 将包含生成的公告的文件的名称。如果没有指定值,插件将使用模板的名称。
筛选 细绳 2.4 定义过滤器参数以限制从 JIRA 检索哪些问题。filter 参数使用与 JIRA 搜索中使用的相同格式的 url 参数。
介绍 细绳 2.0-beta-2 发布的工件的简短描述或介绍。此参数将传递给模板。
默认值为${project.description}
问题管理系统 列表 2.4 从中获取版本的问题管理系统列表。此参数替换参数 generateJiraAnnouncementjiraMerge

有效值为:changes.xmlJIRA

注意: <project>/<issueManagement> 中配置的问题管理系统只能使用一个。这目前意味着您可以将 changes.xml 文件与另一个问题管理系统结合使用。
吉拉合并 布尔值 2.1 已弃用。从 2.4 版开始,此参数已被弃用。请改用 issueManagementSystems 参数。
默认值为false
jira密码 细绳 2.1 定义用于在私有 JIRA 安装中进行身份验证的 JIRA 密码。
吉拉用户 细绳 2.1 定义 JIRA 用户名,用于在私有 JIRA 安装中进行身份验证。
分辨率ID 细绳 2.0-beta-2 将来自 JIRA 的问题包含在这些解决方案 ID 中。多个分辨率 id 可以指定为逗号分隔的 id 列表。

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


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

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


默认值为关闭
模板编码 细绳 2.1 模板编码。
默认值为${project.build.sourceEncoding}
跟踪密码 细绳 2.4 定义用于在私有 Trac 安装中进行身份验证的 Trac 密码。
跟踪查询 细绳 2.4 定义用于搜索工单的 Trac 查询。
默认值为order=id
跟踪用户 细绳 2.4 定义用于在私有 Trac 安装中进行身份验证的 Trac 用户名。
网址 细绳 2.0-beta-2 工件的分发 URL。此参数将传递给模板。
网址下载 细绳 2.0-beta-2 可以下载工件的 URL。如果未指定,则不使用 URL。此参数将传递给模板。
版本前缀 细绳 2.5 在 JIRA 中命名版本时使用的前缀。

如果您在 JIRA 中有一个项目,其中包含多个具有不同发布周期的组件,则经常使用的模式是使用组件名称作为版本前缀,例如 maven-filtering-1.0 等。从 JIRA 获取问题以发布您需要将此参数设置为“maven-filtering-”的“maven-filtering”组件。


网络密码 细绳 2.4 为 JIRA 网络服务器的基本身份验证定义 http 密码。
网络用户 细绳 2.4 为 JIRA 网络服务器的基本身份验证定义 http 用户。

参数详情

宣布参数

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

公告文件

将包含生成的公告的文件的名称。如果没有指定值,插件将使用模板的名称。
  • 类型java.lang.String
  • : 2.4
  • 要求
  • 表达式${changes.announcementFile}

基于

当前项目基目录。
  • 类型java.lang.String
  • : 2.1
  • 要求
  • 表达式${basedir}

开发团队

开发工件的团队的名称。此参数将传递给模板。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.developmentTeam}
  • 默认值${project.name} 团队

过滤器

定义过滤器参数以限制从 JIRA 检索哪些问题。filter 参数使用与 JIRA 搜索中使用的相同格式的 url 参数。
  • 类型java.lang.String
  • : 2.4
  • 要求

最终名称

要在公告中使用的工件的名称。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.finalName}
  • 默认值${project.build.finalName}

生成Jira公告

已弃用。从 2.4 版开始,此参数已被弃用。请改用 issueManagementSystems 参数。
标记以确定插件是否会生成 JIRA 公告。
  • 类型布尔值
  • 2.0-beta-2
  • 要求
  • 表达式${generateJiraAnnouncement}
  • 默认值

简介

发布的工件的简短描述或介绍。此参数将传递给模板。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 默认值${project.description}

问题管理系统

从中获取版本的问题管理系统列表。此参数替换参数 generateJiraAnnouncementjiraMerge

有效值为:changes.xmlJIRA

注意: <project>/<issueManagement> 中配置的问题管理系统只能使用一个。这目前意味着您可以将 changes.xml 文件与另一个问题管理系统结合使用。
  • 类型java.util.List
  • : 2.4
  • 要求

吉拉合并

已弃用。从 2.4 版开始,此参数已被弃用。请改用 issueManagementSystems 参数。
如果来自 JIRA 的版本应该与来自 changes.xml 文件的版本合并。
  • 类型布尔值
  • : 2.1
  • 要求
  • 表达式${changes.jiraMerge}
  • 默认值

吉拉密码

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

吉拉用户

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

最大条目

从 JIRA 获取的最大问题数。

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

  • 类型整数
  • 2.0-beta-2
  • 要求
  • 表达式${changes.maxEntries}
  • 默认值25

输出目录

将生成模板文件的目录。
  • 类型java.io.File
  • 2.0-beta-2
  • 要求
  • 表达式${project.build.directory}/announcement

分辨率标识

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

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

  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.resolutionIds}
  • 默认值固定

runOnlyAtExecutionRoot

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

状态标识

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

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

  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.statusIds}
  • 默认值关闭

模板

用于格式化公告的 Velocity 模板。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.template}
  • 默认announcement.vm

模板目录

包含模板的目录。

注意:此目录必须是 /src/main/resources/ 或当前项目基目录的子目录。

  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.templateDirectory}
  • 默认org/apache/maven/plugin/announcement

模板编码

模板编码。
  • 类型java.lang.String
  • : 2.1
  • 要求
  • 表达式${changes.templateEncoding}
  • 默认值${project.build.sourceEncoding}

跟踪密码

定义用于在私有 Trac 安装中进行身份验证的 Trac 密码。
  • 类型java.lang.String
  • : 2.4
  • 要求
  • 表达式${changes.tracPassword}

跟踪查询

定义用于搜索工单的 Trac 查询。
  • 类型java.lang.String
  • : 2.4
  • 要求
  • 默认订单=id

跟踪用户

定义用于在私有 Trac 安装中进行身份验证的 Trac 用户名。
  • 类型java.lang.String
  • : 2.4
  • 要求
  • 表达式${changes.tracUser}

网址

工件的分发 URL。此参数将传递给模板。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${project.url}

网址下载

可以下载工件的 URL。如果未指定,则不使用 URL。此参数将传递给模板。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求

版本

工件的版本。
  • 类型java.lang.String
  • 2.0-beta-2
  • 要求
  • 表达式${changes.version}
  • 默认值${project.version}

版本前缀

在 JIRA 中命名版本时使用的前缀。

如果您在 JIRA 中有一个项目,其中包含多个具有不同发布周期的组件,则经常使用的模式是使用组件名称作为版本前缀,例如 maven-filtering-1.0 等。从 JIRA 获取问题以发布您需要将此参数设置为“maven-filtering-”的“maven-filtering”组件。

  • 类型java.lang.String
  • : 2.5
  • 要求

网络密码

为 JIRA 网络服务器的基本身份验证定义 http 密码。
  • 类型java.lang.String
  • : 2.4
  • 要求

网络用户

为 JIRA 网络服务器的基本身份验证定义 http 用户。
  • 类型java.lang.String
  • : 2.4
  • 要求

xml路径

changes.xml 文件的路径。
  • 类型java.io.File
  • 2.0-beta-2
  • 要求
  • 表达式${basedir}/src/changes/changes.xml