Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Introduction
Templates can be customized with the help of the following elements -
Image Added
Static text - This is the text that is rendered as it is in the final release notes document generated by ARN
Output variables - These are some of the important data points regarding different Jira entities such as Project, Version, User & so on. These are replaced with actual values at the time of final release notes document generation
Custom variables - Read Manage custom variables
JQL sections - These are the configurable sections that determine which Jira issues are pulled into the final release document, what attributes (default as well as custom) for those issues are included & how the result should be laid out. This is the gist of ARN’s template visual builder
Stats & charts - These are almost similar to the JQL sections, the only difference being they end up showing a number of instead of actual Jira issues
Output variables
In order to make the templates generic, output variables are used. Majority The majority of these output variables are available across all template types, however, there are a few that will be specific to a given template type.
Image AddedRelevant information is highlighted at the appropriate places below :-
List of supported output variables
Users |
Project |
Version |
Sprint |
Date & Time |
Confluence |
releasePageURL (only available in ‘Release page notification’ Release page notification and LinkedIn announcement template type) |
Above variables are available in below template types & fields -
Email
Email subject
Email body
PDF
Content
MS Word
Word content
Confluence
Page title
Page content
JSON
Content
HTML
Content
Markdown
Content
JSM announcement
Announcement subject
Announcement message
Linkedin announcement
Announcement subject
Announcement message
URL title and description
MS Word
File name
MS Word content
MS PowerPoint
File name
JQL sections
JQL section
JQL section is the core of ARN release notes templates. Each JQL section represents a group of issues in Jira. Within the JQL section, you can provide additional configurations for each of the results.
Image AddedWe tweak Jira’s JQL a bit in ARN, so that it supports input variables such as [versionId], [versionName], [projectId], [sprintId], [sprintName]. You can always increase the number of input variables by simply appending 1, 2 & so on to their names.
e.g. if you need to create a template that generates release notes from 3 versions, simply use the following inputs input variables in the JQL - [versionId], [versionId1], [versionId2]. In this case, the template can accept 3 different versions as inputs.
Info |
---|
Read more about the possibilities of JQL here. |
There are a few variants of the JQL section. All of those are explained below. Variant 1 is the most prevalent common one.
Expand | ||
---|---|---|
| ||
This variant of JQL section creator/editor is available in -
Introduction JQL determines what issues from Jira to include in the release notes. Image RemovedIssue fields selector Note that by using variables in the JQL, we have tweaked it a little bit to suit ARN’s use case. Image AddedOn the Add/Edit JQL pop up, click on Fields tab, it shows issue fields selector that dictates what information is shown in the release notes for the selected issues. You can choose default as well as custom fields from the dropdown. Image RemovedImage AddedField customisationcustomization Furthermore, each issue field that you’ve chosen to be a part of release notes can be further customisedcustomized. Click on the already added field & that (or the gear icon beside it) & which will reveal the additional settings available for the field. e.g. clicking on the issue key reveals the following. Grouping JQL section can return results grouped by any available field. You can add up to two fields in ‘group by’ the Group by configuration. When two ‘group by’ Group by fields are added, issues returned by JQL will be grouped by the second ‘group by’ Group by field within each group created by the first 'group Group by' field. This group by field can be further configured by clicking on the left-hand ‘Group by’ Group by selection. Grouping by Cascade Field A field type ‘Select Select List (Cascade) ’ stores two values for an issue parent field and child field. Customizing ‘Group by’ fields layoutlayout with Group by field There are two approaches to customize ‘Group customizing Group by' fields.For older templates, apply custom CSS styling to the label & value of Group by field. In this approach the group by field layout is hardcoded and cannot be modified. Image RemovedNew ‘Group by’ WYSWYG WYSIWYG editor New templates will see a new flexible way to customize ‘Group by’ Group by fields and their layout. This editor can be accessed by clicking on customize option in ‘Group by’ Group by section. Just like a sequential layout editor, you can include field variables & apply customizations. Make sure {JQL_results} variable is added at the end which will be replaced by the Table/Sequential layout of the Jira issues data fetched by the JQL.
For older templates Apply custom CSS styling to the label & value of Group by field. In this approach the group by field layout is hardcoded and cannot be modified. Image Added |
Expand | ||
---|---|---|
| ||
This variant of JQL section creator/editor is available in -
Introduction Image RemovedImage AddedJQL determines what issues from Jira to include in the release notes. Issue fields selector dictates what information is shown in the release notes for the selected issues. You can choose default as well as custom fields from the dropdown. Image RemovedImage AddedField customisation JSON is a view-less, structured format & thus the customisation options are limited. One can modify the JSON structure, labels & ARN will echo the changes. Grouping Grouping is not possible within these this variant of the JQL sections. |
Expand | ||
---|---|---|
| ||
JSD announcements is essentially an HTML text along with a title. To cater to this specific behaviour, ARN provides simple visual builder for JSD announcement type of templates. Image RemovedImage AddedBoth, announcement subject & message fields, allow for variables to be added to them. |
Stats
Read more here - Stats & charts
On this page | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Iframe | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|