Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Introduction
Initial approach for the AI-generated release notes was taken for the existing Jira issue fields and custom fields where users can store AI-generated release notes in selected Jira issue fields and custom fields. Later on, one more advanced approach was introduced to allow users to save release notes in Jira issue properties which does not need the creation of additional custom Jira issue fields. Let us check this approach in detail.
Issue properties
Expand | |||||||||
---|---|---|---|---|---|---|---|---|---|
Below are the issue properties that are introduced under the property key - ARNreleaseNotes
|
Consider this before you decide whether to use custom fields or issue properties
Expand | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Storing AI release notes in Jira issue properties
Expand |
---|
Using Generator tabNavigate to Generator tab. On the generator tab below fields are displayed, select relevant options as required.
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.
Currently ARN support multiline text and single-line text Jira issue/custom fields for AI-generated release notes.
Once done with generating/updating content, click on Update Jira issues at the bottom of the Screen. 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 actionUsers 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. |
Fetching release notes from Jira issue properties
Expand |
---|
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 sectionsOnce 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 layoutFor 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 layoutIn Sequential layout, when the issue property field is added. One needs to add it to the editor as shown in below image. Image AddedOutput will look like this - Image AddedUsing releasenotespagesWhen 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. Using widgetsSimilar 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. |
Consider this before you decide whether to use custom fields or issue properties
Expand | ||||
---|---|---|---|---|
Custom fields | Issue properties | Advantages |
| |
Disadvantages |
|
|
On this page | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Iframe | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|