Use JIRA API Classes in Custom Release Notes Template


I am working on setting up release notes template to match our existing format. I have two questions that I need some help:

First question: I'd like to get the real path of the attachments shown in the release note. I found com.atlassian.jira.util.AttachmentUtils provides getAttachmentFile method that I can use. What should I change in releasenotes-html.vm file to be able to use AttachmentUtils class? Or is there any other way to get the path of the files?

My second question is how can I get a list of predefined variables (such as $project, $version, $issueTypes) that are available in releasenotes-html.vm?

1 answer

I'm not sure whether the internal Release Notes feature allows you to access JIRA internals, but the PDF View Plugin does and you can use it to generate really smart Release Notes documents:

  1. Working with attachments (even including the attached files directly in the Release Notes doc)
  2. Full list of model objects ("predefined variables") that can be accessed in the template

Here is a sample output for your interest.



Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

2,783 views 11 18
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot