使用自定义公告模板

公告生成目标使用Velocity模板来创建公告。如果需要,您可以创建自己的自定义模板。

配置插件

首先,您必须配置插件并告诉它您的模板在哪里。在此示例中,我们要使用模板${basedir}/src/main/resources/our-announcements/my-announcement.vm

注意: < templateDirectory>必须是${basedir}/src/main/resources/的子​​目录。

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-changes-plugin</artifactId>
        <version>2.12.1</version>
        <configuration>
          <template>my-announcement.vm</template>
          <templateDirectory>our-announcements</templateDirectory>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>

创建您的模板

接下来,您要创建自己的模板。明智的做法是从插件中包含的默认值开始。你可以从这里的 Subversion 下载它。它将为您提供有关如何迭代发布操作等的示例。

可用变量

以下是您在创建自己的模板时可以使用的变量列表:

标有 * 的变量是只读的。
多变的 类型 自从 描述
发布* 列表 2.0 来自 changes.xml 文件或 JIRA 的所有版本。
组ID* 细绳 2.0 项目 pom 中的 groupId。
工件 ID* 细绳 2.0 项目 pom 中的 artifactId。
版本* 细绳 2.0 您项目的 pom.xml 中的版本。
包装* 细绳 2.0 来自您项目的 pom.xml 的包装。
发布* 发布 2.0 您要发布的版本。
项目* Maven项目 2.1 正在发布的 Maven 项目。
网址 细绳 2.0 工件的分发 url。默认值为${project.url}
介绍 细绳 2.0 对已发布工件的简短描述或介绍。默认值为${project.description}
开发团队 细绳 2.0 开发工件的团队的名称。默认值为${project.name} team
最终名称 细绳 2.0 要在公告中使用的工件的名称。默认值为${project.build.finalName}
网址下载 细绳 2.0 可以下载工件的 URL。默认值为${project.url}
宣布参数 地图 2.1 可以在插件配置中指定的自定义参数映射。

每个版本还有一组变量:

标有 * 的变量是只读的。
多变的 类型 自从 描述
行动* 列表 2.0 在此版本中完成的所有操作。
发布日期* 细绳 2.0 发布此版本的日期。
描述* 细绳 2.0 发布说明。
版本* 细绳 2.0 此版本的版本。

最后,每个Action都有以下变量:

标有 * 的变量是只读的。
多变的 类型 自从 描述
行动* 细绳 2.0 做了什么。
开发* 细绳 2.0 进行更改的开发人员。
由于* 细绳 2.0 如果这是来自非开发人员的贡献,则为该人的姓名。
由于电子邮件* 细绳 2.0 如果这是来自非开发人员的贡献,则为该人的电子邮件地址。
问题* 细绳 2.0 问题跟踪系统中问题的关键。
类型* 细绳 2.0 这是怎样的变化。

从 2.8 开始,Velocity Context 包含ToolManager提供的所有默认工具。有关详细信息,请参阅工具使用摘要

有关如何访问模板中的变量等信息,请参阅Velocity 用户指南