...

In order to generate your first release notes please follow a few simple steps:

1. Navigate to “Release notes” tab in the board menu

2. Click create template button:

   Image Modified

3. Specify template name and save a template with a default body:

   Image Modified

4. Click “Generates Notes“ button

5. Choose version from a list and click “Generates Notes“ button

   Image Modified

6. Download generated release notes as HTML or upload to confluence

   Image Modified

Release notes templates

Templates operations

...

• Define text style

• 3 fonts are supported

• Bold, Underlined, Italic styles

• Define text color and background

• Text alignment

• Insert numeric or bullet lists

• Insert a link

• Pictures

• Code block

• 🆕 Custom HTML tables

Also, the user can inject version/package variables into the template body. The variables will be replaced with actual values from the selected version/package during rendering the notes.

...

The following configuration parameters are available for the table:

...

1. Name of the section. A section with the same name will be added to the release notes.

2. Columns to be shown in the table. User can select the majority standard and custom Jira fields. See details in the chapter below.

3. Section description. If the text is specified - it will be added as a plain text after the section name.

4. JQL variables. In order to build flexible JQL which will use data from the selected version or package the user can inject variables to JQL query. List of available variables depends on the template type

   1. Version specific variables

      1. Version name

      2. Start date

      3. Release date

      4. Version JQL (precompiled JQL which can help to extract the content of real or virtual version)

      5. Project key ( Not applicable for virtual version)

      6. User name

      7. Current date

      8. Current timestamp

   2. Package specific variables

      1. Start date

      2. Release date

      3. Version JQL (precompiled JQL which can help to extract the content of package)

         1. Please note that “Versions in package” variable is not supported since October 2020

      4. User name

      5. Current date

      6. Current timestamp

5. JQL query to extract an issue list. 

6. If the option is enabled the section will be rendered if JQL will return 0 rows. Otherwise, the section will not be rendered at all.

7. If this option is enabled all the issue will be grouped by respected Jira Epics.

   Image Modified

8. Show epic key if grouping by epic is enabled

9. The message which will be injected to a template if JQL will return 0 rows. This option will be working in case a switcher #6 is turned on.

...