JSON
To customise content of the JSON template, read this - Customising release notes content
To add the JSON action in a rule, read this - Actions
Create a Json 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. Change the dropdown selection to ‘Json’.
Default template will be populated. Make any required changes & save them to create a new template.
Edit a Json template
An existing Json 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 - Templates | What are template levels local & global?
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 a JSON template
An existing Json 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 delete button in the right-most column of the template list view.
Template that cannot be deleted
If the template was not created within the current project, then it cannot be deleted here. ‘Delete’ button will not be available in this case.
Preview a JSON template
Once you have completed the JSON template, it can be previewed and downloaded immediately. Just click on the Preview button once desired changes have been done.
On preview page, select given variables and click on Preview again. This will generate the Json template preview in your browser. If what you see is the desired result, now you can Save and Download the template if needed.
Read on to learn more about Generating release notes from multiple versions in a project
Note
Here JQL section is added in JSON format. One can add a JQL section from the button. Edit & delete actions are only possible from within the JSON only. The JQL section pop-up is different than in case of other formats & just generates a JSON-formatted counterpart of JQL section.
Json template fields
Template name
This is for internal reference & doesn’t show up on the actual release page.
Level
Local or Global - Determines whether the JSON template is available to be used in other projects across Jira.
Cross-project - On ARNR’s cross-project screen, this field is disabled from editing & set to ‘cross-project’ by default.
Content
The actual JSON content is generated based on this.