How to publish Jira release notes to Confluence automatically

By Jake Marsh · Updated

To publish Jira release notes to Confluence automatically, install Changeleaf on Jira and Confluence on the same site, then a space admin opens the space's Changeleaf settings, picks a template, turns on Save a draft note when a version in this space is released and ticks Also publish it to Confluence with a Confluence space and parent page. Each time a version in that space is released, the note is generated and the page is created. Releasing the version again refreshes the same draft and the same page instead of adding another.

What Jira does on its own

From a version in Jira Cloud you can create release notes as a Confluence page that lists the version's work items, or have Rovo draft one if your site has it. Both start a new page when you ask. They don't keep the page in step with the version afterwards, and the wording comes from ticket summaries or a generated draft rather than notes your team wrote on each work item.

Steps: publish on every release

  1. Add Changeleaf to Jira and to Confluence on the same site. One subscription covers both.
  2. Open the Jira space's settings > Changeleaf. You need to be a space admin.
  3. Choose the template the space's notes use, such as Customers.
  4. Turn on Save a draft note when a version in this space is released.
  5. Tick Also publish it to Confluence, then choose the Confluence space and, if you want, a parent page such as "Release notes". You need permission to add pages in that space.
  6. Release a version as you normally do. The draft appears in Saved notes under Apps > Changeleaf, and the page appears under the parent you chose.

Steps: publish one note by hand

  1. In Apps > Changeleaf, pick the versions and template and click Generate notes.
  2. Fix the wording in Edit lines if you need to, then Save as draft.
  3. Choose a Confluence space, optionally give a parent page id, and click Publish to Confluence.
  4. When the version changes later, open the note from Saved notes. It is generated again from Jira with your edits kept, and Changeleaf tells you which work items came in or went out. Click Update the page.

How page updates behave

SituationWhat happens
You click Update the page and the note changedThe same page is rewritten
You click Update the page and nothing changedThe page is left alone, so watchers get no notification
A page with the note's title already exists in the spaceChangeleaf updates that page instead of failing
You delete the saved noteThe Confluence page stays as it is

Pages you publish by hand are published as you. Drafts made at release time are created by the app, so they leave out work items with an issue security level; open the draft and refresh it to add those as yourself before you update the page.

Before the first release

Notes are only as good as the text on each work item. Before you release, search Jira for work items that still need one:

fixVersion = "3.5" AND releaseNoteWritten is EMPTY

That finds every work item in the version with no note in the Changeleaf panel that isn't marked to be left out. To set the wording, sections and audiences, see how to set up a release notes template in Jira.

Changeleaf starts with Atlassian's 30-day free trial; prices are on the Changeleaf page.

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 I need Confluence to use Changeleaf?

No. Without Confluence you can still generate, save and copy notes in five formats. Confluence is only needed to publish pages.

Can each Jira space publish to a different Confluence space?

Yes. The setting is per Jira space, with its own template, Confluence space and parent page.

What happens if I release the same version twice?

The same draft and the same page are refreshed. No second page is made.

Can I edit the Confluence page by hand?

You can, but the next Update the page rewrites it from the saved note. Make wording changes in Edit lines so they survive.


More Changeleaf guides


More Jira guides