Related help articles
To customize content of the email template, read this - Customising release notes content
To add the email action in a rule, read this - Actions
To configure your own address (only available in the Cloud version) for sending out emails, read this - Setting up SMTP (to send emails via your company domain)
Create an email template
Navigate to the templates page on the ARNR screen & click on the ‘Create’ button.
You will be brought to the template creation page where Email will be selected by default.
Default template will be populated. Make any required changes & save them to create a new template.
Above screenshot is take from the cross-project screen so the Level field shows the Cross-project option selected by default and cannot be changed. If you wish to create a Global template, create the template from in-project screen.
+AI generator macro in template is to add a summary of the issues for given JQLs. Please read AI generator in templates for more details.
Edit an email template
An existing email template can be edited by clicking on the template name link from the list. To identify Email templates you can check the Type column, also you can filter templates by type.
Also notice the columns called Created by and Last modified by for additional details.
This will bring you to the template edit screen, which is the same as that of create - except, data is pre-populated for the current template. Make any required changes, click on save and the template is updated.
Local level templates can always be edited right away. But whether a global template can be edited in the given project depends on where it was created. If it was created within the current project, then it can be edited otherwise it cannot be.
To know more about template levels, read this - Templates | What are template levels local & global?
Template that can be edited
Template that you can edit will have editable pre-populated data in fields and the Save button at the left bottom of the screen.
Template that cannot be edited
If the template was not originally created within the current project, then it cannot be edited here. ‘Save’ button will not be available in this case. And an additional message is displayed indicating the parent project for the template.
Delete an email template
An existing email template can be deleted by clicking on the delete icon from the list.
Local level templates can always be deleted right away. But whether a global template can be deleted in the given project depends on where it was created. If it was created within the current project, then it can be deleted otherwise it cannot be.
To know more about template levels, read this - Templates | What are template levels local & global?
Template that can be deleted
Template that you can delete will have a delete button in the rightmost column of the template list view as shown in the image above.
Template that cannot be deleted
If the template was not originally created within the current project, then it cannot be deleted here. ‘Delete’ button will not be available in this case.
Preview an email template
When creating or editing an email template, it can be previewed immediately. Just click on the ‘Preview’ button, once desired changes have been done.
This will bring you to the preview page. Choose inputs based on JQLs used in the template & click Preview.
Read on to know more about Generating release notes from multiple versions in a project and Adding issues from different projects to release notes
This will generate the email template preview.
If what you see is the desired result, go back and save the template.
Email template fields
Template name
This is for internal reference & doesn’t show up in the actual release emails.
Level
Local or Global - Determines whether the email template is available to be used in other projects across Jira.
Email templates on cross-project screen have this field disabled from editing & set to ‘cross-project’ by default.
Empty check
If checked, the release email is not generated when none of the JQL sections return any Jira issues. e.g. Imagine if no issues have been tagged against a given fix version & that version is mistakenly marked as released. If an ARNR rule is executed (based on the version release trigger), the email action won’t generate the release email.
Email subject
Subject of the release email that the system will generate. Variables are supported within the subject line.
ARNR branding
If checked, following line is added to the ARNR-generated emails at the bottom - ‘This email is generated by Automated release notes & Reports add-on for Jira.’
Email body
The actual release email content is generated within the email body.