Multiple Reports

How to generate Release Notes and a Release Plan

This documentation shows how multiple reports can be generated for a given project.

Prerequisites: It is expected that there is a custom field with name cf_type specifying the issue types. Per default the following issue types are considered in the report: New Feature, Change Request, Improvement, and Bug. You may change the values by setting the properties sectionType and sections.

It is also required that the target milestone is activated.

To generate the Release Notes and the Release Plan report add the following configuration to your report's plugins section: 

<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>

    <!-- Default values
    <sectionType>cf_type</sectionType>
    <sections>New Feature,Change Request,Improvement,Bug</sections>
    -->
  </configuration>
  <reportSets>
    <reportSet>
      <reports>
    	  <report>bugzilla-releasenotes-report</report>
        <report>bugzilla-releaseplan-report</report>
    	</reports>
    </reportSet>
  </reportSets>
</plugin>

Please refer to issues:bugzilla-releasenotes-report and issues:bugzilla-releaseplan-report on details how to configure the query and select the columns to be shown.

Even more reports at once

This example shows how multiple reports can be configured. It includes the Release Notes, Release Plan, Breaking News, and New and Noteworthy reports. 

<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>
	      <reports>
	    	  <report>bugzilla-releasenotes-report</report>
	    	  <report>bugzilla-releaseplan-report</report>
	    	</reports>
	    </reportSet>
	    <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>
	    <reportSet>
	      <id>newAndNoteworthy</id>
	      <reports>
	        <report>bugzilla-issues-report</report>
	      </reports>
	      <configuration>
	        <outputName>new-and-noteworthy</outputName>

	        <title>New and Noteworthy</title>
	        <description>This version presents the following key features.</description>
	        <noResultsDescription>This release is a bugfix release and contains no new key features.</noResultsDescription>

	        <keywords>info.noteworthy</keywords>
	        <columns>bug_id,short_desc</columns>
	        <columnWidths>65,0</columnWidths>
	      </configuration>
	    </reportSet>
	  </reportSets>
	</plugin>

Please note that each reportSet provides a unique identifier (id) and each tabular report set specifies the name of the file to which the report is written (outputName). The name of the file is relative to the report output directory (typically the site directory within the target folder) and specifies no file name extension.

Whenever you specify the columns you also have to specify the columnWidths (where zero (0) indicates no explicit width).