Generate automated release notes for Jira Cloud
Generate timely release notes for keeping your team up to date.
1. Setup your Jira project
Your team is using Jira in order to plan and deliver the work on your software product ? That's a very good start !
Hopefully as all the improvements and bug fixes are handled there (I'm looking at you, last minute hotfixes in production), Jira is a pretty good place to source all the changes to your product that need to be shared with your colleagues, clients, and other stakeholders.
2. Install the LiveChangelog release notes Jira addon
Configuring Jira to generate automated release notes is extremely easy with our free addon from the Atlassian Marketplace :
This addon is compatible with Jira Cloud, and works for both classic and next-gen projects that are getting more and more popular among teams.
To install it, you will need administrator privileges in your Jira team. Don't worry, once this step is completed, anyone from your team can generate release notes using LiveChangelog.
3. Follow the instructions to link your two accounts together
Once the addon is installed in your Jira workspace, click "Getting Started". Then, follow the instructions to get your LiveChangelog and Jira accounts linked together :
First, click "Link LiveChangelog Account" inside Jira. You will be asked to log-in in a new tab to your account.
If multiple teams share a common Jira instance, you can absolutely link multiple LiveChangelog accunts.
If you do not have a LiveChangelog account yet, just sign-up, it only takes a few seconds !
4. Create a LiveChangelog Project linked to Jira
Sign into your LiveChangelog account, click Projects > New project.
If you see your Jira project in the drop-down, it means that your have set up the integration correctly.
Give a name to your project, and click Save.
5. Filter out the completed issues from Jira
Once issues are completed in Jira, they are pushed automatically to the "Changes awaiting publication" section at the top of the screen.
Not all changes are worthy to be published. Indeed, while your users care very much about new improvements and critical bug fixes, technical operations or improvements that do not have any visible impact are best left out of your release notes.
As those will have been pushed from Jira, click the small trash bin to delete them.
6. Create a new release note and publish it
You're there ! Ready to tell the world about your awesome improvements.
Relevant changes are grouped into Releases.
You may want to create one release for each sprint that your team completes, or split them further into different releases if you are working on multiple features at the same time.
Click "Create new Release", add a few notes if you'd like to give a bit of context or information besides the list of changes, select the changes you'd like to publish, and click Save.
In order to publish your Release note straight away, select "Published" as its status, and select a publication time. You can select "Draft" if you'd like to publish it later.
7. Share your release note as part of your product changelog
Once your release note is set as "Published", it is visible in your product changelog.
See How can I share my product release notes ? in order to learn the different ways of sharing your product changelog.