How to make one release note from several Jira versions and spaces
By Jake Marsh · Updated
Jira Cloud's release notes cover one version in one space at a time. To make one note from several, open Apps > Changeleaf, pick every version you want from any spaces you can browse (or click Same name across spaces to add every version called, say, "4.2"), choose a template and click Generate notes. You get one note, and a work item that belongs to more than one of those versions is listed once.
When you need this
- One product, several spaces. The web app, mobile app and API each have their own Jira space and their own "4.2".
- A month of small releases. Your team ships 4.2.1, 4.2.2 and 4.2.3 and customers want one note for the month.
- A platform release. Shared services and the apps on top ship together under different version names.
Atlassian has an open feature request for release notes across versions and spaces, JRACLOUD-42776. Without it, each version gets its own page.
Steps
- Open Apps > Changeleaf.
- Pick versions. Search and add versions from any spaces you can browse. Same name across spaces adds every version with the name you choose.
- Choose a template. It decides the sections and the line for each work item.
- Click Generate notes. The summary line counts work items per section and lists what was left out and why.
- Check Work items without a release note, which lists the ones that still need a sentence and who owns them.
- Save as draft if you'll regenerate it later, and copy it or publish it to Confluence.
Grouping a combined note
| You want | Set in the template |
|---|---|
| Sections by kind of change (New, Improved, Fixed) across every space | Sections by work item type, group by space off |
| One block per space, with sections inside | Group by space on |
| The space shown on each line | Add {space} to the line |
| Which versions a work item shipped in | Add {versions} to the line |
| Every space named in the title | Use {spaces} in the title |
So for a monthly note, a title such as Changes in {versions} with the Customers sections gives readers one list, while an internal note with group by space on shows each team's part.
Saved notes keep up as versions change
Open a saved note from Saved notes and it is generated again from Jira. Edits you made in Edit lines are kept, and Changeleaf tells you which work items came in or went out since you saved, which matters when a work item moves from 4.2.2 to 4.2.3 halfway through the month.
Notes are generated as you, so a combined note only includes work items you can see in each space.
Changeleaf starts with Atlassian's 30-day free trial; prices are on the Changeleaf page. For the wording and sections themselves, see how to set up a release notes template in Jira.
What it costs
Changeleaf is From $6 a month for up to 10 users. Every plan and the install link are on the Changeleaf page.
Changeleaf: Release Notes from Versions for Jira
Release notes from Jira versions, written by your team, shaped per audience, across spaces, saved and published to Confluence. From $6 a month for up to 10 users.
Questions
Do the versions need the same name?
No. Pick any versions from any spaces. Same name across spaces is a shortcut for the common case where they share a name.
Will a work item in two versions show twice?
No. Each work item appears once in the note, and {versions} on the line shows every version it is in.
Can I make a note from versions that aren't released yet?
Yes. Pick unreleased versions to draft notes ahead of a release. Unfinished work items are left out unless the template includes them.
Can I keep the versions in sync across spaces too?
Changeleaf reads versions as they are and doesn't change them. Keeping one release in step across spaces is a separate job.
More Changeleaf guides
- How to set up a release notes template in Jira
- How to publish Jira release notes to Confluence automatically
More Jira guides
- How to set up a code freeze in Jira (Cutline)
- How to book shared test environments in Jira (Berth)
- How to find duplicate issues in Jira (Mergewell)
- How to bulk delete attachments in Jira Cloud (Attachwell)