Using the new Generator feature, you can easily generate release notes through AI by simply selecting an input Jira field. The system will read the contents of the selected field summarize or rephrase them and provide refined and meaningful release notes as an output. You can also choose the tone of your release notes.

Enable the ‘Generator’ feature

Your Jira admin shall have to enable this app setting -Allow release notes generation through AI. Admin can enable it from the ARNR configurations screen that is available within the ‘Manage apps’ menu. Know more.

Navigation

• Navigate to the ARNR from the relevant Project’s in-project menu

• Click on Generator tab

Open

Using prompts

Deafult prompt

When using deafult prompt you need to provide details in given fields to execute AI-generated content in given issues. Below are fields and their details.

Open

Custom prompt

Custom prompt allows you to provide a detailed prompt to the AI generator so it can provide you results based on the given prompt. In custom prompt, all below fields are applicable except Action, Tone, Maximum words, Output language as these details can be added to the custom prompt itself.

Fields in the AI generator

Using AI Generator

Use case (When using Jira issue/custom fields option)

Let us take a use case here with the default prompt. A product manager wants to Publish release notes using ARNR. They have created all the necessary templates, rules & actions within ARNR. In a Jira project, they have two description fields, 1st is Desciption which contains internal issue description. 2nd is the Description for Public Release notes.

In this case, they only want to write the internal description and let the AI generator update the Description for Public Release notes. So it is published in release notes where they have used the custom field Description for Public Release notes in their ARNR template.

Input in the AI generator fields

In the above image, notice different fields are selected like Action is Summarise, Tone is Professional. Maximum words are 500. Output language is English(US). The input field is the default issue description and the output field is Description for Public Release notes, a custom field.

Below JQL - project = AbhilashPractiseProject3 AND issuetype = Task, this JQL returned one issue from the given project and fix version.

Response by AI generator

When clicked on Get release notes Suggestions, it shows the columns and results as below -

• Key - Issue key

• Description column - Shows original description in the issue

• Suggessions - Shows suggestions by AI generator.

• My Input - Allows you to add input to the AI-generated content. If you make any changes, click on icon and save.

• Choice - It shows below options (Same is available as dropdown when one or more issues are selected as highlighted in below image)

  • Keep existing content - Keeps the original/existing content in the output field

  • Use suggestion as it is - Uses suggested content as it is in the output field

  • Use content from my input - Uses content you have updated in the output field

Check above image for the reference.

One can select the choice column options one by one for all issues or in bulk from the dropdown available at the top and click on Update choices. Once updated, the selected option updates the same choice for all listed updates. Check above image.

Update Jira issues action

Once all above steps are completed, click on Update Jira issues. The system updates the content and shows a success message.

If we check the Jira issues, it shows the updated content.

Once the Jira issue field is updated with AI-powered release notes, that field then can be utilized in ARNR’s template for the final release notes document to be generated.

Troubleshoot errors

Update issue action can fail in the following cases

• When the user lacks permission to update the output field

• When the user lacks permission to disable email update notifications.