Release Notes

The release notes report lists all closed issues of the specified product and component.

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.

Release Notes Report Example

It is also required that the target milestone is activated.

To generate the Release Notes 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>

    <renderEmailAdresses>true</renderEmailAdresses>

    <!-- 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>
    	</reports>
    </reportSet>
  </reportSets>
</plugin>

In the given example the properties bugzillaUser and bugzillaPassword provide the credentials to log into the issues system.

The properties issues-component and issues-product specify on which component of which product the report is requested.

The property renderEmailAdresses renders eMail addresses as clickable links. Useful for intranet sites. For internet sites this may better be left to the default value (false).

The section above the report is included because of the feature Adding an Introduction. A file is placed in the folder src/site/relnotes named release-notes-report-0.1.0.xml with the following XML content: 

<document>
  <body>
    <subsection name="The first Release!">
      <p>
        This is the first release of the issues-plugin. <b>Enjoy it!</b>
      </p>
      <p>
        Please do not hesitate to send us your comments.
      </p>
    </subsection>
  </body>
</document>

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