JIRA

Install

Admin

Use

	JIRA Administrator's Guide Introduction Getting Help Look and Feel Logo, Colours and Timezone Configuring the default Language Configuring the default Issue Navigator Configuring the default Dashboard Overview of Dashboard Portlets Enabling Portlets and Other Plugins Editing the Announcement Banner Enabling Logout Confirmation Email Email Overview Creating a Notification Scheme Customising Email Content Creating Issues & Comments from Email SMTP configuration User Management Managing Users Managing Groups Managing Project Roles Migrating from Groups to Project Roles Enabling public signup and CAPTCHA Integrating JIRA with LDAP Integrating JIRA with Crowd Configuring Trusted Applications Security Overview Global permissions Project permissions Issue security Project Management Defining a Project Assigning members to Project Roles Defining Project Components Defining Project Versions Creating Release Notes for a Version Generating Release Notes Adding New Format Templat.. Configuring Project Keys Configuring Fields and Screens Overview Defining 'Resolution' field values Defining 'Priority' field values Defining 'Status' field values Defining 'Issue Type' field values Associating Issue Types with Projects Translating Resolution/Priority/Status/Type Configuring field behaviour Configuring rich-text renderers Associating behaviour with Issue Types Placing fields on screens Associating screens with Issue Operations Associating screens with Issue Types Creating & configuring Custom Fields Custom Field Overview Adding Custom Fields Configuring Custom Fields Configuring Workflow Workflow Activating Workflow Events Importing from Other Systems Importing from Bugzilla Importing from Mantis Importing from FogBugz Importing from Excel/CSV Moving or Archiving Individual Projects Overview Archiving a project Merging JIRA instances Splitting JIRA instances Integrating with Source Control Integrating with CVS and ViewCVS Integrating with Subversion Integrating with Perforce Integrating with ClearCase Integrating with FishEye Configuration Options & Settings Global Settings Enabling Issue Linking Enabling Sub-tasks Enabling Trackback linking Enabling Time Tracking Enabling File Attachments Enabling Thumbnails for Attachments Server Administration Indexing & Search Backing up Data Automated Backups Restoring Data Database Integrity Checker Increasing memory Performance Tips Database Indexing Precompile JSP pages Logging and Profiling Thread Dump Downgrading (Ent to Pro) Downgrading (Ent to Std) Downgrading (Pro to Std) Using robots.txt with Search Engines Appendix A - Extending JIRA Extension Overview Listeners Services Jelly tags JIRA Toolkit Customising Text Developer Guides JIRA Plugins JIRA RPC Overview Creating a SOAP Client Creating an XML-RPC Client Creating Custom Field Types Custom Workflow Elements Creating new Portlets Creating new Reports More.. JIRA Source Building JIRA from source API Documentation

Project Release Notes

PDF

JIRA provides the functionality to create release notes for a specific version of a project. The release notes contain all issues within the specified project that are marked with a specific "Fix For" version. The release notes can also be generated in a number of formats (e.g. HTML, plain text, etc.) so as they can be included in various documents.

At present, two example format templates are provided - HTML and Text - using Velocity templates. Further format templates can be created and added to the system.

Generating Release Notes

Select the Browse Projects option from the main menu
Select the project from which you wish to create release notes.
Select Release Notes.
Select the required format of the release notes - HTML and plain text format templates are provided.
Select the required project version for which the release notes will be generated.
Selecting the Create button will generate the release notes using the specified template in the specified format. The release notes are displayed as HTML and also within a text area in the actual format selected - allowing the contents to be copied for inclusion in another document.

Note

It is also possible to create a default set of release notes using the HTML format template. By selecting the Roadmap option from the Reports menu, it is possible to create the HTML release notes for each un-released version by selecting the Release Notes link after each version title.

Adding New Format Templates

Create a Velocity template similar in content to that of the examples provided - releasenotes-text.vm and releasenotes-html.vm. Consult the JIRA API documentation and the Jakarta Velocity User Guide.
The title within the template should be modified along with the code within the text area. The other sections of the template do not need to be modified.
Add the new format template to the list within the jira-application.properties file. A corresponding entry must be made in both the jira.releasenotes.templatenames and the jira.releasenotes.templates lists. It is also necessary that the entries in both lists are in the same order.
Restart JIRA.
The new format template is available for selection as a release note format template.

Also see the tutorial on How to Create a Custom Release Notes Template Containing Comments.