更改:公告生成

全名:

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

说明:

从公告模板生成公告的目标。

属性:

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

必需参数

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

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


默认值为:25。
用户属性是:changes.maxEntries。
输出目录 文件 2.0-beta-2 将生成公告文件的目录。
默认值为:${project.build.directory}/announcement。
模板 细绳 2.0-beta-2 用于格式化公告的 Velocity 模板。
默认值为:announcement.vm。
用户属性是:changes.template。
模板目录 细绳 2.0-beta-2 包含模板的目录。

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


默认值为:org/apache/maven/plugin/announcement。
用户属性是:changes.templateDirectory。
版本 细绳 2.0-beta-2 工件的版本。
默认值为:${project.version}。
用户属性是:changes.version。

可选参数

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

有效值为:changes.xml和 JIRA。

注意: <project>/<issueManagement> 中配置的问题管理系统只能使用一个。这目前意味着您可以将 changes.xml 文件与另一个问题管理系统结合使用。
问题类型 地图 2.6 将问题类型映射到操作类型,以便在公告中对问题进行分组。如果未为操作类型定义问题类型,则将应用默认问题类型。

有效的操作类型:add、fix和 update。


吉拉合并 布尔值 2.1 已弃用。从 2.4 版开始,此参数已被弃用。请改用 issueManagementSystems 参数。
默认值为:false。
用户属性是:changes.jiraMerge。
jira密码 细绳 2.1 定义用于在私有 JIRA 安装中进行身份验证的 JIRA 密码。
用户属性是:changes.jiraPassword。
吉拉用户 细绳 2.1 定义 JIRA 用户名,用于在私有 JIRA 安装中进行身份验证。
用户属性是:changes.jiraUser。
分辨率ID 细绳 2.0-beta-2 将来自 JIRA 的问题包含在这些解决方案 ID 中。多个分辨率 id 可以指定为逗号分隔的 id 列表。

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


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

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


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

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


用户属性是:changes.versionPrefix。
网络密码 细绳 2.4 为 JIRA 网络服务器的基本身份验证定义 http 密码。
用户属性是:changes.webPassword。
网络用户 细绳 2.4 为 JIRA 网络服务器的基本身份验证定义 http 用户。
用户属性是:changes.webUser。
xml路径 文件 2.0-beta-2 changes.xml 文件的路径。
默认值为:${basedir}/src/changes/changes.xml。

参数详情

宣布参数:

公告的自定义参数映射。此 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}

问题管理系统:

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

有效值为:changes.xml和 JIRA。

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

问题类型:

将问题类型映射到操作类型,以便在公告中对问题进行分组。如果未为操作类型定义问题类型,则将应用默认问题类型。

有效的操作类型:add、fix和 update。

  • 类型:java.util.Map
  • 从: 2.6
  • 要求:否

吉拉合并:

已弃用。从 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
  • 要求:否
  • 用户属性:changes.versionPrefix

网络密码:

为 JIRA 网络服务器的基本身份验证定义 http 密码。
  • 类型:java.lang.String
  • 从: 2.4
  • 要求:否
  • 用户属性:changes.webPassword

网络用户:

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

xml路径:

changes.xml 文件的路径。
  • 类型:java.io.File
  • 自:2.0-beta-2
  • 要求:否
  • 默认:${basedir}/src/changes/changes.xml