Breaking News

Tabular Report

This report lists all changes that break API or behavior in a tabular manner.

Using this report requires the use of the Breaking Tags.

Breaking News Report Example
<plugin>
  <groupId>de.smartics.maven.plugin</groupId>
  <artifactId>issues-maven-plugin</artifactId>
  <configuration>
    <issueManagementUser>${bugzillaUser}</issueManagementUser>
    <issueManagementPassword>${bugzillaPassword}</issueManagementPassword>

    <!-- If issue-product is not specified, all products are considered. -->
    <product>${issues-product}</product>
    <!-- If issue-component is not specified, all components are considered. -->
    <component>${issues-component}</component>
    <renderEmailAdresses>true</renderEmailAdresses>
  </configuration>
  <reportSets>
    <reportSet>
      <id>breakingNews</id>
      <reports>
        <report>bugzilla-issues-report</report>
      </reports>
      <configuration>
        <outputName>breaking-news</outputName>

        <title>Breaking News</title>
        <description>The following changes break API or behavior of the previous version.</description>
        <noResultsDescription>This release contains no changes that are known to break API or behavior.</noResultsDescription>

        <keywords>break.api,break.runtime,break.deprecated,break.removed</keywords>
        <columns>bug_id,short_desc</columns>
        <columnWidths>65,0</columnWidths>
      </configuration>
    </reportSet>
  </reportSets>
</plugin>

Section Report

To generate a simple, sectioned (requires the issue types and target milestone property) report containing the breaking changes, add the following report set to your POM (the only difference to the report above is the report bugzilla-section-report).

<plugin>
  <groupId>de.smartics.maven.plugin</groupId>
  <artifactId>issues-maven-plugin</artifactId>
  <configuration>
    <issueManagementUser>${bugzillaUser}</issueManagementUser>
    <issueManagementPassword>${bugzillaPassword}</issueManagementPassword>

    <!-- If issue-product is not specified, all products are considered. -->
    <product>${issues-product}</product>
    <!-- If issue-component is not specified, all components are considered. -->
    <component>${issues-component}</component>
    <renderEmailAdresses>true</renderEmailAdresses>
  </configuration>
  <reportSets>
    <reportSet>
      <id>breakingNews</id>
      <reports>
        <report>bugzilla-section-report</report>
      </reports>
      <configuration>
        <outputName>breaking-news</outputName>

        <title>Breaking News</title>
        <description>The following changes break API or behavior of the previous version.</description>
        <noResultsDescription>This release contains no changes that are known to break API or behavior.</noResultsDescription>

        <keywords>break.api,break.runtime,break.deprecated,break.removed</keywords>
        <columns>bug_id,short_desc</columns>
        <columnWidths>65,0</columnWidths>
      </configuration>
    </reportSet>
  </reportSets>
</plugin>