JIRA Release Notes via REST API

e June 20, 2012

Hello there,

is there a REST API call available to generate Release Notes for a specific version? I only saw the method to get the unresolved Issues within a specific version (JIRA 5.0.x is used here).

I have to following use case:

We currently have multiple JIRA projects and all those projects should be built and released at the same moment. Currently we're generating the Release Notes of each single project version manually and merge the content together (HTML output). The big win would be if we can automate that via a REST call and little program logic (JAVA/C#):

* Fetch release notes for n version (in different projects)

* Merge the release notes to one big release note list

* Deploy the generated file/content to XY.

Thanks in advance

2 answers

1 accepted

Comments for this post are closed

Community moderators have prevented the ability to post new answers.

Post a new question

0 votes
Answer accepted
Jobin Kuruvilla [Adaptavist]
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.
June 20, 2012

There is nothing for release notes in REST. Did you try using JQL to fetch issues within a release?

http://docs.atlassian.com/jira/REST/latest/#id163399

e June 20, 2012

seems legit, thanks ;)

0 votes
Midori
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 13, 2014

PDF View Plugin exposes a public API that you could utilize to solve your use case.

The API function you need renders a PDF document from a template and from a list of issues:

/**
	 * Renders a PDF document using the specified template from the passed issues.
	 * @param templateName identifies the template to use. Example: templates/plugins/pdfview/issue-filename.vm.
	 * @param title the title for the resulted PDF document.
	 * @param issues the issues to be exported in the PDF document.
	 * @param additionalModel additional model objects that are passed to the PDF renderer. They can be used in the template code as regular Velocity variables. (This is purely optional and may be just an empty map.)
	 * @return the result object containing the PDF document filename and its actual bytes.
	 */
	RenderingResult getPdf(String templateName, String title, List issues, Map additionalModel);

In your case, you should first execute a JQL query to get all issues that belong to all the versions to be released, and then pass that result to this method to generate your PDF. That, there is no need to concatenate anything, there is a single release notes document generated!

See more info about the PDF API and customizing the PDF templates

TAGS
AUG Leaders

Atlassian Community Events