JQL Block

Use the power of JQL blocks to display a list of Jira issues within your templates

JQL Block

The JQL block is a versatile component of the template that allows you to display Jira issues in a tabular format. Each column in the table represents a specific issue field, providing a comprehensive view of the relevant information. The JQL block includes a JQL query, which is executed to retrieve the desired issues and populate the table accordingly. This powerful feature enables you to dynamically showcase Jira issue data within your templates, enhancing the clarity and effectiveness of your release notes.

Add new JQL Block

To incorporate a new JQL block into your template, simply click on the '+JQL Block' button located on the toolbar. This action will add a default JQL block with predefined issue fields such as Type, Key, Summary, and Status, along with the JQL query ORDER BY created DESC. By customizing the JQL query, you can precisely filter and display the desired Jira issue data within your template, ensuring the accuracy and relevance of your release notes.

JQL Block Settings

The Settings of the JQL Block offer you the ability to customize its appearance and manage the fields within it. You can modify the view of the block, adjusting its visual presentation according to your preferences. Additionally, you have the flexibility to change the JQL query associated with the block, enabling you to refine the data retrieved. With these settings, you can tailor the JQL Block to suit your needs and ensure that it effectively captures and displays the desired information. With these customizable settings, you can fine-tune the JQL Block to showcase Jira issue data in a manner that best supports your release notes.

JQL Block Fields

The settings of the JQL Block provide you with the flexibility to customize its appearance and functionality to suit your preferences. You can modify the view of the block by showing or hiding headers, borders, or icons, allowing you to create a visually appealing and streamlined presentation. Additionally, you have the ability to add, delete or rearrange the sequence of fields by simply dragging and dropping them, enabling you to tailor the layout to your specific needs.

Furthermore, you can choose to make a field within the block a clickable link that directly navigates to the corresponding Jira issue, enhancing the accessibility and convenience of accessing detailed information.

JQL Block Query

The JQL Query feature allows you to customize the query used to retrieve Jira issues and populate the table within the JQL Block. The JQL query is validated to ensure it is a valid JQL expression, providing an added layer of reliability. Moreover, you can leverage variables to dynamically insert values into the query, allowing for more dynamic and adaptable querying. With this capability, you can fine-tune the JQL query to precisely retrieve the desired Jira issues and effectively populate the table within the block.

Variables

  • {{sprint}} - Completed sprint name. Available when trigger is Close of sprint
  • {{version}} - Released version name. Available when trigger is Release of version

Examples of JQL Query

fixVersion="{{version}}" OR component="v-{{version}}" ORDER BY created DESC
sprint="{{sprint}}" AND issuetype="Story" ORDER BY created DESC