Templates

Templates is the page where you can manage your templates. Templates uses WYSIWYG to help you to create unique templates to match your company style.

Templates listing

Template listing is the page where you can see all you created templates. Also, you are able to perform Create, Edit, Copy and Delete actions from the listing.

JQL blocks

JQL block is a component of template which consists from a table where each column is issue field.
Also, there is a JQL query of the block. The purpose of JQL block is to run JQL query, get the issues and populate the table.

JQL block settings

JQL block settings allows you to set up UI settings, fields and JQL query.

JQL block fields

When you insert a block into a template it contains three issue fields: Key, Summary and Status.
In block settings "Settings" tab you are able to manage the fields. You cannot delete all fields, minimum one is required.
Also, you can drag and drop fields to change position. And finally, you can make a link for issue field. This field will be linked to Jira issue page.

JQL block query

When setup is triggered the plugin runs JQL query to filters out Jira issues and populated the block table.
Each query is validated and only valid queries are saved.

Variables

Release notes template support the following list of variables

  • {{setupName}} - setup name
  • {{releaseDate}} - date of release notes are sent
  • {{version}} - released version name. Available when trigger is "Release of version"
  • {{versionDescription}} - released version description. Available when trigger is "Release of version"
  • {{sprint}} - completed sprint name. Available when trigger is "Close of sprint"
  • {{sprintGoal}} - completed sprint goal. Available when trigger is "Close of sprint"

Moreover you can make a little programming with variables in the template. You can use #if and #unless conditional helpers for better template representation.

#if, #if else

This helper checks for existance of variable value. For example if you want to create general template for sprint completion and fix version release and want to display information when it exists. Then you can use #if helper.

{{#if sprint}}Sprint: {{sprint}}{{/if}} displays "Sprint: Sprint 3 - Q2 2022" only when sprint is available
{{#if version}}Version: {{version}}{{/if}} displays "Version: v1.2.1" only when version is available

Example of #if else

{{#if sprintGoal}}
   {{sprintGoal}}
{{else}}
   There is no sprint goal description
{{/if}}

#unless, #unless else

#unless helper is opposite of #if helper. It checks if variable does not exist.
For example if fix version does not have description then display default text. It also supports else part.

{{#unless versionDescription}}There is no description for this fix version{{/unless}}

Logs