1. Introduction
2. Creating a read only module
3. Moving finalised bugs to the read only module
4. Generating release notes
5. Customising release notes

This howto outlines the procedure for managing a release and generating release notes from Ozibug. This procedure is intended as a guide only and may not be appropriate for all sites.

As the admin user, create a new read only module.

A suggested naming convention is to use the base module name plus the version number, eg., if the base module is Ozibug and the version about to be released is 1.2.0, then the new module would be named Ozibug 1.2.0.

Note: Any custom categories used in the base module should also be enabled in the new module, or the corresponding data will not be reflected in the new module.

As a manager, select the base module and filter the bugs that will form the new release. Update the module of all required bugs to the new read only module.

This will move the selected bugs from the base module to the new read only module.

Select the reports option from the top navigation panel, then select the new read only module. Scroll down to the middle section entitled release notes, select the template to use, the sorting field and hit submit to generate the release notes.

The release notes are displayed in a new browser window. You can now use your browser to save the contents of the release notes to a local file.

While it is intended that the template used to generate the release notes will produce a reasonable document, it is expected that further customisation will be required to finalise it. This may include additional formatting or including or excluding additional material on a bug, etc.