Create release notes

If you organize your Jira Software projects with versions, you can generate release notes for all the issues within a version, categorized by issue type. This allows you to quickly copy all the changes associated with your release so you can create a release notes document.

Release notes can include rich text and plain text fields. However, media such as images, videos, and other files, are not yet supported.

Create release notes in Confluence

1. Go to your project and select Releases from the project menu. 

2. Select the Version you want to generate release notes for.

3. Select Release notes.

4. Use the dropdown menu to select a space, folder, or parent item. This is where you can find the release notes page in the Confluence sidebar navigation.

5. Select which issue types you want to include.

6. Select the issue fields you want to include.

7. Select Create in Confluence to create your release notes. The Related work section in your version should now contain a link to your release notes in Confluence.

Edit your release notes in Confluence

Release notes are created in Confluence as a draft page that includes an expand containing links to all of your issues and the related fields you selected.

The table at the top includes details on the release, including a smart link, the date, your description, and everyone who worked on one of the issues.

You can edit the page to craft a customized set of release notes for your intended audience.

To edit your release notes in Confluence:

1. Select the Edit icon or type e to edit your Confluence page.

2. Create a Summary of the release or type /ai to use Atlassian Intelligence to create one.

3. Copy or rewrite the content of the issues table to provide details on New features, Improvements to existing features, or Bug fixes.

4. Remove any information or issue field column that is not intended for release.

5. Select the lock icon to set permissions for the page.

6. Select Publish to create the page.

Create release notes in Jira

To create release notes for a version in your Jira Software project:

1. Go to your project and select Releases from the project menu.

2. Select the Version you want to generate release notes for.

3. Select Release notes.

4. Select the create release notes in Jira link. The Create release notes window opens.

5. Select Formatting options to choose the fields you want to include in your release notes.

6. Select Copy to clipboard to copy the release notes and paste them in a text file as markdown or HTML, or select Save release notes to save your release notes in the Related work section of your version.

Copying release notes as markdown

If your release notes document includes panels, dates, expand sections, or statuses, you won't be able to copy your release notes as markdown, as these attributes are not yet supported. You’ll only be able to copy your release notes as HTML. Alternatively, you can edit your release note formatting options to remove any fields that contain unsupported attributes, and then copy your release notes as markdown.

Add a “release notes” field to your Jira issues

To create custom release notes for each of your Jira issues, add a rich text field to your Jira issues:

1. Open any issue in your Jira project.

2. Select Configure under the Details panel.

3. Add a Paragraph field.

4. Give your new field a name (for example, “Release notes”).

5. Use this field to add custom release notes to the issues in your version.

6. Navigate to your version and select Release notes, then select Formatting options. Your new rich text field will now be available to add from the ISSUE FIELDS list.