Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Background
Every organization has its unique approach to utilizing Jira. Due to its flexibility and extensive structure, there is no single prescribed method for its use. Thus, that is where we thought of making ARN flexible enough to suit any type of approach for publishing release notes and reports for its users.
The following components are fundamental to nearly all types of ARN templates. These elements, functions, and macros enable the creation of diverse release notes and reports. If any component does not apply to a certain type of template, relevant warnings are mentioned there.
Issue Scope
Tip |
---|
Comming soon! We will soon update this page once the feature is available! |
(Output) Variables
Excerpt | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
These are the data points used to bring the values from Jira to your release notes content. The variables will be replaced by actual values for given data points. Some examples are projectName, fixVersion, userName, etc. When you use such variables, upon execution of the template, variables are replaced with actual values. List of supported output variables
|
Custom variables
Excerpt | ||
---|---|---|
| ||
Apart from the default variables that are typically the default fields, users may want to create custom fields and fetch that data to release notes. In such a case one can map the ARN custom variables with their Jira fields and bring the values of those fields to release notes. All the custom variables created in ARN are global. It means, that irrespective of the projects they are created from, all non-deleted custom variables will be visible across all the projects. In below image, notice the way ARN custom variable is used. When executing the template, this is how the preview will asks for the value of the custom fields. This just one simple use case, Read how to Manage & use ARN custom variables with more examples. |
JQL section
Excerpt | ||
---|---|---|
| ||
Introduction to JQL sectionThis section plays a crucial role in ARN templates. JQL dictates the appearance of your content and determines the data to be included in release notes and reports. It serves as the central hub for all information intended for end users. There are three tabs on Add/Edit JQL section pop-up -
|
Excerpt | ||
---|---|---|
| ||
SectionIn the section tab you will find below fields to define the content that will be posted in the release notes.
|
Excerpt | ||
---|---|---|
| ||
FieldsThis tab is to display what all Jira issue fields/custom fields that are to be added to your release notes. If the Table layout is selected then these fields are added as columns. You can add the numbered columns In the case of the sequential layout, selected fields will be listed in the sequence you have added them. As shown in the below image, ⚙️ icon in front of each selected field would show some extra settings for the field like header style, Entry Style, display as link or text, etc. Read how to Save release notes without Jira fields using issue properties. |
Custom CSS
Excerpt | ||||
---|---|---|---|---|
| ||||
IntroductionTo further customise the release notes that ARN generates, it is possible to configure custom CSS within different templates. How toNote that custom CSS can be applied only when the layout of the template is Tabular. Sequential layout does not support applying custom CSS as it already uses a WYSWYG editor. Open any one of the above-mentioned template types & click on any JQL section to open it in Edit mode or start to Create a new one. Make sure the layout/format is set to Table. Custom CSS can be applied for any of the selected columns, listed in the left-hand section of the Fields tab. Click on the gear icon beside any column name & it will reveal a couple of free text fields where custom CSS can be added. Header styles refer to the styling applied to the table header for that specific column whereas Entry styles CSS attributes are applied to all the data points generated within that column. If the JQL section data is grouped by a specific column, it is possible to apply custom CSS to that data as well. Just click on the Gear icon beside Group by option. It shows the custom CSS options.
|
Layout
Excerpt | ||
---|---|---|
| ||
Table layoutThis layout is fairly straightforward & does not need any additional configurations. All the fields that are selected (from Feilds tab as shown in the above image), will be displayed as table columns from left to right. Below is a sample screenshot of the generated release notes in tabular format. In this example you can see coulmn in the table like Priority, Key, Status, Issue type, and Summary. At the left top corner of tble notice the Task issue type icon which means the table is grouped by the issue type. This way using different customisation you can define the way of displaying issues from the given release. |
Excerpt | ||
---|---|---|
| ||
Sequential layoutSelecting equential layout presents the selected fields (from the Fields tab) in a sequenced format. The desired layout needs to be designed within the area highlighted below. Here, the design is simply a sequence of available variables. These variables are displayed based on what fields you have chosen on the Fields tab. Any fields that you have selected to be used, can be arranged in any order you wish. For every field that is configured under Fields tab on the left, there will be two variables on the right. One that will fetch the field value & other to fetch its display label. e.g. for Priority field, there are two variables - {priority} & {priorityLabel}. Required condition is, you have to add fields & their configurations before they can be used in the Layout section. The layout created will be repeated for every issue that is returned by your section JQL. For example, layout in the above screenshot will generate data that looks like the below screenshot. In below image check the check box called Hide field label variable when the field value is empty. If this is checked, and if the JQL does not fetch any data in the field value against a particular issue, then it hides the field variable and you can make sure that the release notes do not look like an incomplete piece of information.
|
How Group by function work?
Tip |
---|
Somenew enhancements for Group by function are in the making 🛠️ 🏗️. We will soon update here! Stay tuned! |
How to sort 'Group-by’ fields in a JQL section
Excerpt | ||
---|---|---|
| ||
The Order by clause in JQLs respects the sorting of Group by fields as well. This means that groups created by the Group by fields in the JQL section can be ordered in the desired sequence. Additionally, you can now choose where to place orphan elements of the respective Group by field. This update provides greater flexibility and control over the organization of your data. Here is an example:
Orphan elements
|
Stats & charts
Excerpt | ||
---|---|---|
| ||
IntroductionARN provides Stats & charts macro to make release notes more insightful for you & your team. To put it simply, Stats feature comes up with a number that corresponds to the count of issues that are returned by the configured JQL & chart feature lets you include a simple bar chart showing the count of issues returned by configured JQL aggregated over values of specific Jira field. |
Excerpt | ||
---|---|---|
| ||
StatsClicking on Stats & charts would open a pop-up where the system accepts a JQL. And a return value. Return value identifies what kind of data will have to be extracted from the Jira issues that the JQL returns. Typical use cases may include, informing the audience about
Currently, the system can return a number of issues the stored JQL retrieves. So a typical use of this would look something like the image below. Note that you can also optionally display the number as a link that leads back to Jira. Sample stats generated with ARN: |
Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Charts - bar chartClicking on Stats & charts would open a pop-up, select the type as Bar chart. Below are the fields you have to to add or edit while creating a Bar chart.
Once this setup is saved, bar chart place holder image will be inserted into the template. Users can resize this image to resize the designated area for the bar chart within the template. No of issues returned by the JQL will be aggregated against the unique value of the selected Jira field and a bar chart will be included within the area designated within the template. Below image shows how the final chart will be rendered in preview/output when release notes. |
Highlight contributors of release notes using 'Users' macro
Excerpt | ||
---|---|---|
| ||
This is a custom plugin called Users to ARN template that highlights your team members as contributions who led to the success of the release. This simple yet interesting plugin allows you to recognize your team members and give them credit of the release’s success. How to use the User macro/plugin?This plugin is by default added at the end of the template. Click on it and edit given fields below -
Below image shows the sample output preview of the email. |
AI generator
Excerpt | ||
---|---|---|
| ||
ARN templates now feature an AI-powered summary of the issues retrieved by a given JQL. This enables you to swiftly share a concise overview of the content included in the release notes or release notes report you're preparing. The process is as straightforward as adding a JQL section but with an AI element. StepsWhile customising any of the above templates, you will notice an option called +AI generator in the template editor. Clicking on this +AI generator opens up a pop-up with the below fields -
When you select 'Use a Jira issue Field' it list down all Jira issue fields of the below type -
Once you are done with specifying all the above fields, click on Insert. You can check the preview to check what content AI has generated. You edit the content manually or update the prompt based on the given content and what you were expecting as a result.
|
Table of contents (TOC)
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
This macro is availble in the PDF template to add the table of contents. Clicking on this macro opens up the below pop-up with some fields -
|
On this page | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Iframe | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|