Add a new custom style for Jira release notes

Erwin Manuel May 28, 2013

Hi,

I would like to know if it is possible to add new release note template/style for Jira 5.2.

Based on this link: https://developer.atlassian.com/display/JIRADEV/Creating+a+Custom+Release+Notes+Template+Containing+Release+Comments#CreatingaCustomReleaseNotesTemplateContainingReleaseComments-Step2:CreatingCustomVelocityTemplatesforReleaseNotesReports, it is possible to customize the template but what we want is to add a new template so that there will be 3 Release notes style options: HTML, Text and 'Custom Style'

2 answers

1 accepted

0 votes
Answer accepted
Svante Gustafsson Björkegren
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
May 28, 2013

Hi,

This is possible!

Just do the following:

  1. Create your new velocity template for your "Custom Format" according to the instructions in the link you found. Name it: releasenotes-custom.vm
  2. Shutdown JIRA
  3. Update the file <JIRA-HOMEDIR>jira-config.properties (if this file does not exist, create it!) The JIRA-HOMEDIR is the directory where your attachments and stuff is stored, usually in /.../application-data/jira
    Add the following rows to the file:
  4. jira.releasenotes.templatenames = Text, Html, Custom
    jira.releasenotes.templates = releasenotes-text.vm, releasenotes-html.vm, releasenotes-custom.vm,
    jira.releasenotes.default = Custom
  5. Copy your custom velocity template to <JIRA-INSTALLDIR>/atlassian-jira/WEB-INF/classes/templates/jira/project/releasenotes
  6. Start JIRA

Now you should have three options when generating Release Notes.

Hope that helps!

Kind regards,

// Svante

0 votes
mwarton
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
October 10, 2013

Hi Erwin,

In case you are looking for an easier option, check out the plugin Intelligent Reports. It lets you design your relase notes template in Microsoft Word, and select which issues to include, JQL queries, custom fields etc by a powerful point and click interface. One of the example templates it comes with is Release Notes, so you can use that as a starting point.

Suggest an answer

Log in or Sign up to answer