Documentation for JIRA 4.4. Documentation for other versions of JIRA is available too.
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.
releasenotes-text.vm
and releasenotes-html.vm
. Consult the JIRA API documentation and the Apache Velocity User Guide.jira-config.properties
file. For each new template format, corresponding entries must be added to the existing values of the following properties:
jira.releasenotes.templatenames
jira.releasenotes.templates
jira-config.properties
file, then for each of these properties, add the property's name, followed by an '=
', followed by the content of the property's corresponding <default-value/>
element copied from your JIRA installation's jpm.xml
file. Next, begin adding the corresponding entries for the new format template.jira-config.properties
file for more information.Also see the tutorial on How to Create a Custom Release Notes Template Containing Comments.