Documentation

“Release Notes” is an add-on for Jira by Atlassian, created to allow users to generate Release Notes for their projects.
Jira project admins can customize how the Release Notes will look like.

Each user with access to the project can generate Release Notes and export them to PDF

Open

Create a new setup, for example (Customer Release Notes)

Open

You can configure the following:

1. Company logo to include in Release Notes

2. Should include (or not) issue icon and issue key

3. Which issue types to include in the Release Notes

4. Which field value should be taken to the Release Notes

5. Set Release Notes RTL or LTR direction.

Open

By default, the Release Notes show all issue types, each type has a header and lists all the issues under it, for example:

1. Header “Task” and all tasks in the version under this header

2. Header “Story” and all stories in the version under this header

3. Header “Bug” and all bugs in the version under this header

And so on…

In “Issue Type Grouping” you can define custom headers and select which issue types should be under it, for example:

1. Header “What’s New 🎉” with types “Task” and “Story” under it

2. Header “Bug Fixes” with types “Bug” and “Troubleshooting” under it

In “Custom Content Sections” you can create a new custom header and select which field represents this section, for example:

1. Header “Security” with a custom field called “Security Release Notes”.
   For every ticket in the version, if the custom field “Security Release Notes” is filled with a value, the ticket will be shown in the Release Notes under the “Security” section with the content of the custom field.

2. Header “Ops” with a custom field called “Ops Release Notes”.
   For every ticket in the version, if the custom field “Ops Release Notes” is filled with a value, the ticket will be shown in the Release Notes under the “Ops” section with the content of the custom field.