• We introduced a new family of issue properties with the property key - ARNreleaseNotes

• Whenever a Jira ticket has release notes, the system stores relevant release notes against the corresponding issue property for that Jira ticket.

• The information against the issue properties will be stored within Jira using these Jira APIs.

• There is no character limit on issue properties. However, there is a limit on the size of the JSON file

Below are the issue properties that are introduced under the property key - ARNreleaseNotes

• When generating release notes using the Generator tab, if the issue property is selected instead of a custom field to store the release notes, then upon generation of the release notes in the generator tab, new issue properties will be created and the release notes will get saved

• When executing a rule action for a template in which the JQL has been configured to store the release notes in issue properties, upon rule execution, new issue properties will be created and the release notes will get saved in those issue properties

Using Generator tab

Navigate to Generator tab. On the generator tab below fields are displayed, select relevant options as required.

• Action - Define whether you wish to Summarise or Rephrase the content

• Tone - Define the tone from given options like Professional, Casual, Hunorouse

• Maximum words - Spefify the maximum number of words of the output

• Output language - Specify output language. Current options are - English (UK and US), French, Dutch, Polish, Spanish and Genman.

• Input Jira issue field - Jira issue field that will provide the input to AI generator

Now below feilds are the main part of using Jira issue properties instead of actual Jira issue/custom fields. Let us see that in detail.

• Where to store release notes? - With this field, there are two options -

  • Use a Jira issue Field - User this option if you want to store the output in any existing Jira issue field/custom field.

  • I prefer not to use a Jira issue field - When this option is selected, system shows a new dropdown field with two options

    • Brief summary

    • Detaled description

  • These are the issue properties as explained in above table and JSON. Once you select the correct option, proceed with further fields as explained below.

• JQL to fetch issues for which AI-assisted release notes are needed (Mandatory) - JQL to fetch issues that you want to update with the output suggested by the AI generator

• Hide issues which have "Input Jira issue field" empty - Check this box if you wish to hide issues with no input data in the selected Jira issues field

• Get release notes suggestions - Once all the above information is updated. click on this button to generate the suggestions.

• If there are multiple issues listed and you wish to update selected issues or all of them you can use the below given options.

  • You can update multiple issues at the same time from the dropdown at the top or the Choice column.

Open

Once done with generating/updating content, click on Update Jira issues at the bottom of the Screen.

Open

Once the success message is displayed, that means the updated content is stored in selected Jira issue properties that can be later fetched in different templates using JQL sections. You can also use these issue properties via JQLs within release pages or widgets. Explained in the last section of this document.

Using AI generator rule action

Users can also make use of the AI generator rule action called Generate release notes using AI when they want to auto-generate and auto-publish release notes using the rule action.

As displayed in above image, one needs to select all the relevant field options like Action, Tone, etc. These are the same as explained in above section related to AI generator tab. Similarly to use Jira issue properties to save content one can select Brief summary or Detailed Description option.

Based on the trigger selcted in the rule, this action will be executed and AI-generated release notes content will be stored in selected Jira issue proerty that is Brief summary or Detailed description.

Once user has stored AI-generated release notes content using either the generator tab or the rule action, it is time to understand how to fetch these release notes. One can fetch these release notes using the below options based on whether they are using any ARN template, Release notes, or Widget. Let us see all three options.

Using JQL sections

Once the AI generated content is stored in the Jira issue properties, same can be fetched from JQL sections within different templates being used to publish release notes.

In the below image, notice that in Fields tab, one can add Jira issue property as field.

Once added, using the icon beside the field label, one can edit the label and add Header and Entry style. Based on the given label name, the field will be displayed.

Table layout

For better understanding, in below screenshot, we have kept the Jira issue property name as it is and layout is table layout. So you can notice how ARN allows you to add AI-generated content without creating any additional Jira issue field. This is the preview of Email template. In a similar way one can use any type ARN template.

Sequential layout

In Sequential layout, when the issue property field is added. One needs to add it to the editor as shown in below image.

Output will look like this -

Using release pages

When users want to fetch AI-generated content in release pages, they can use any of the given fields to display AI-generated content and select the relevant Jira issue property.

Read https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/2592931916/Step+by+step+guide+to+Release+pages+Widgets#Release-page---Step-by-step-guide

Using widgets

Similar to release pagesm one can fetch AI-generated content in release pages. They can use any of the given fields to display AI generated content and select the relevant Jira issue property.

Read https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/2592931916/Step+by+step+guide+to+Release+pages+Widgets#Widget---Step-by-step-guide