Documentation

Release Notes Writer for Jira & Confluence

1. Install

1. A site admin installs the app from the Atlassian Marketplace into Jira.
2. To publish pages, install it into Confluence on the same site as well. Without Confluence you can still build and read release notes in Jira.

There is nothing else to set up: the app works with sensible defaults right away.

2. Create release notes

1. Open a Jira project and choose Release notes in the project's apps menu.
2. Pick one or more versions. Unreleased versions are listed first.
3. The work items whose fix version is one of the chosen versions are grouped into New features, Improvements, Bug fixes and Other changes, based on their work type.

Sub-tasks are not listed: the parent work item already describes the change.

3. Publish to Confluence

1. Under the notes, choose a Confluence space. The app remembers it for the project.
2. Check the suggested page title and, if you like, write an introduction.
3. Select Publish page.

Publishing the same versions again (with the same template) updates the same page instead of creating a new one, and keeps your introduction. You can only publish to spaces where you are allowed to create pages.

4. Templates

Project admins can create templates in Project settings → Release notes, for example one for customers and one for the team. A template sets:

• the section titles;
• which section each work type goes to, or Leave out;
• an optional JQL filter, for example labels = public or status = Done;
• whether work item keys (such as ABC-123) are shown.

When a project has more than one template, a Template picker appears on the release notes page. Each combination of versions and template gets its own Confluence page.

5. Automatic publishing

In Project settings → Release notes → Automatic publishing, a project admin can switch on publishing when a version is released, and choose the template and the space.

• When someone releases a version in Jira, its notes are published within a couple of minutes.
• If the notes of that version were already published by hand, that page is updated and keeps its title and introduction.
• Automatic publishing is done by the app itself, not by a person, so work items with a security level are always left out.
• The outcome of the last run is shown on the same settings page.

If the last run says the app is not allowed to add pages, a Confluence space admin needs to give the app access in the space permissions.

6. Write with Rovo

On sites with Rovo, open the Rovo chat and pick the Release Notes Writer agent. Ask, for example:

• Write release notes for MOBL version 2.1
• Write customer-facing release notes for the latest version, neutral tone, using the Customers template

The agent reads the version's work items (only those you can see) and writes in a technical, neutral or marketing tone. It never invents features, numbers or dates. If you open the chat from a work item, the project is picked up automatically. Rovo usage counts towards your site's Rovo allowance.

7. Permissions and data

The app has no admin permissions and no access to email addresses. It runs on Atlassian's Forge platform and sends no data outside Atlassian; its stored settings live in the same region as your Atlassian site. See the privacy policy and security statement.

8. Limits

• Up to 20 versions in one set of release notes.
• Up to 1,000 work items per set of notes (the page says when the list was cut); the Rovo agent reads up to 150.
• Up to 10 templates per project; JQL filters up to 500 characters.
• Like every Forge app, the app is subject to Atlassian platform quotas and rate limits. With very large sites or bursts of activity, a request may need to be retried.

9. Troubleshooting

Still stuck? Contact support.