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 your version

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. Under Create in, select This version.

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.

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. Under Create in, select Confluence.

5. Use the dropdown menu to select the Confluence space or parent page where you want to save your release notes.

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

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 using the Jira issues macro. Your release notes are displayed in a table, where each of the issue fields you selected to include in your release notes appears as a column.

To edit your release notes in Confluence:

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

2. Select the Jira issues macro table and then select the edit icon.

3. Select Display options to adjust the columns and number of issues in your table of issues.

4. Select Insert to save your changes.

Learn more about the Jira issues macro

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.