使用自定义公告模板

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

配置插件

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

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

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

创建您的模板

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

可用变量

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

多变的 类型 内容
发布* 列表 来自 changes.xml 文件或 JIRA 的所有版本。
组ID* 细绳 项目 pom 中的 groupId。
工件 ID* 细绳 项目 pom 中的 artifactId。
版本* 细绳 您项目的 pom.xml 中的版本。
包装* 细绳 来自您项目的 pom.xml 的包装。
网址 细绳 工件的分发 url。默认值:${project.url}
介绍 细绳 对已发布工件的简短描述或介绍。默认值:${project.description}
开发团队 细绳 开发工件的团队的名称。默认值:${project.artifactId}-team
最终名称 细绳 要在公告中使用的工件的名称。默认值:${project.build.finalName}.${project.packaging}
网址下载 细绳 可以下载工件的 URL。默认值:${project.url}
发布* 发布 您要发布的版本。
标有 * 的变量是只读的。

每个版本还有一组变量:

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

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

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

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