AI Generator for AI-powered release notes
- Sujeet Pathak
- Annu
- Anand Inamdar
For ARNR Server-DC app
If you are using ARNR on Jira Server/DC, you will have to connect your Open AI account from the App Settings page to start using this feature. For Jira cloud users, no integration is required.
Once connected, select the Open AI connection in the dropdown and follow the below steps for AI-generated release notes.
Want to connect your own Open AI account for Cloud ARNR app?
Raise a request on out Service desk for early access to the advanced edition of the app. Read ARNR Advanced editions and Free vs Paid apps for more details.
Using the new AI 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 ‘AI 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 AI Generator tab
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.
Currently ARNR support multiline text and single-line text Jira issue/custom fields for AI-generated release notes.
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
Field | Description | Applicable for |
|---|---|---|
Action | Define whether you wish to Summarise or Rephrase the content | Default prompt |
Tone | Define the tone from given options like Professional, Casual, Hunorouse | Default prompt |
Maximum words | Specify the maximum number of words in the output | Default prompt |
Output language | Specify output language. Current options are - English (UK and US), French, Dutch, Polish, Spanish and Genman. | Default prompt |
Input Jira issue field | Jira issue field that will provide the input to AI Generator | Default and Custom prompt |
Where to store release notes? | With this field, there are two options -
| Default and Custom prompt |
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 | Default and Custom prompt |
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 | Default and Custom prompt |
Get release notes suggestions | Once all the above information is updated. click on this button to generate the suggestions.
| Default and Custom prompt |
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.
project = AbhilashPractiseProject3 AND issuetype = Task 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.
On this page |
|---|