To customise content of the markdown template, read this - Customising release notes content
To add the HTML action in a rule, read this - Actions
Create an HTML template
Navigate to the templates page on the ARN screen & click on the ‘Create’ button.
You will be brought to the template creation page where Email will be selected by default. Change the dropdown selection to ‘HTML’.
Default template will be populated. Make any required changes & save them to create a new template.
+ AI generator macro in the template helps you add the summary of issues based on the configured JQL. Read AI generator in templates for more details.
Edit an HTML template
An existing HTML template can be edited by clicking on the template name link from the list.
This will bring you to the template edit screen, which is 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. However, 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 - https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/204013600/Templates#What-are-template-levels---local-%26-global%3F
Template that can be edited
Template that you can edit will have 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 HTML template
An existing HTML 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 - https://amoeboids.atlassian.net/wiki/spaces/ARN/pages/204013600/Templates#What-are-template-levels---local-%26-global%3F
Template that can be deleted
Template that you can delete will have a delete button in the rightmost column of the template list view.
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 HTML template
When creating or editing an HTML template, it can be previewed immediately. Just click on the ‘Preview’ button once desired changes have been done.
This will make you input the necessary variables, based on JQLs used in the template. Provide the inputs, if required, then click on preview.
Read on to know more about Generating release notes from multiple versions in a project
This will generate the HTML template preview in your browser. If what you see is the desired result, save the template.
Download HTML template
Do you wish to download the HTML template output? An additional download option on the template preview screen makes this extremely simple.
HTML template fields
Template name
This is for internal reference & doesn’t show up in the actual release page.
Level
Local or Global - Determines whether the HTML template is available to be used in other projects across Jira.
Cross-project - On ARN’s cross-project screen, this field is disabled from editing & set to ‘cross-project’ by default.
ARN branding
If checked, the following line is added to the ARN-generated HTML at the bottom - ‘This HTML is generated by Automated release notes add-on for Jira.’
Content
The actual HTML content is generated based on this.
For all practical purposes, HTML template is similar to the Email template. An important difference is - the HTML template is made available as a file so that you can put it up on your website or as part of your deployment package.
