Documentation

What is Jira Release Notes?

Jira Release Notes is a Jira plugin for sending automated release notes. It provides slick and intuitive interface to setup automated Jira release notes. It provides template management to customize your template. And rich integration Slack, Teams, Confluence and custom webhooks.

When you install the plugin from Jira marketplace, go to the Jira and on the left sidebar, you will see Release Notes item. Click on the item to open the plugin.

Release Note triggers

Trigger is a way to automatically send release notes when an events accurs. See the following trigger types:

  • Release of Version - Automatically sends release notes when a version is released in Jira Releases. fixVersion = {versionId} will be added to your filters.
  • Close of Sprint - Automatically sends release notes when a Jira sprint is closed. sprint = {sprintId} will be added to your filters.
  • Schedule - Automatically sends release notes on scheduled date at UTC. This is one time operation.
  • Interval - Automatically sends release notes when interval period is matched from start date.
    Interval periods:
    • Daily - Release notes is sent every day at UTC starting from start date
    • Weekly - Release notes is sent every 7 days at UTC starting from start date
    • Biweekly - Release notes is sent every 14 days at UTC starting from start date
    • Monthly - Release notes is sent each month date at UTC starting from start date. If month's date is greater than the current month last date then release notes is sent on the last date of the month.
    • Quarterly - Release notes is sent each quarter at UTC starting from start date.
  • Manual - Sends release notes only when you click on Execute button

Release Note filters

There are two types of issue filters for your release notes. They are very close how filters work in Jira.

  • Basic - These filters provides simple and user-friendly UI to define complex queries without knowing JQL
  • JQL (Jira Query Language) - This mode provides advanced criteria to filter issues.

Categorize issues

Since issue types in Jira are dynamic we cannot determine what kind of issue types are related to a specific category. These categories will help us to sort issues by type in the release notes template.

Template settings

This section helps you to manage release notes template. Select template, preview template and select template format.

Template format

There are two types of template formats:

  • PDF – PDF file will be generated and attached to release notes email
  • HTML – Release notes email will be in HTML format

Template Studio

If you would like to customize your template, click "Edit template" button or just to to Template Studio. You can modify template styles and settings. On each style change, you will see a reactive template update.

Version

You can add specific release note version on the template. This version will be ignored if your trigger is "Release of Version". Version name will be used instead.

Description

You can add description of the release notes. Description could be taken from "Sprint goal" or "Release description" fields when your triggers "Close of Sprint" or "Release of Version" respectively. See next "Settings" section to enable these fileds.

Settings

Description source

  • Sprint goal - This option forces to use "Sprint goal" as a template description when release note trigger is "Close of sprint"
  • Version description - This options forces to use "Version description" as a template description when release note trigger is "Release of Version"

Issue Custom Title

Sometimes issue title is not suitable for release notes. If you would like to use another title then use the "Release Notes Title" field. This custom field will be added when you install the plugin. If this field is empty then the "Summary" field will be used by default.

Slack notification

If you use Slack chat messenger, you can set up a notification to the chat room when release notes happened. The notification contains text and link to the generated release notes.

Click on Slack button on the Notifications block. Slack settings opened in popup.

Slack settings

Once you click on Slack button, settings are opened. Let’s set up Slack notification.

Webhook URL

Use Slack documentation page about Incoming Webhooks to create Webhook and enter created Webhook to this field. If you already have the Webhook just use it. This field is required.

User name

This option determines user name you get notification from. By default, it is “Release Notes bot” but you can change to any.

Example of Slack notification message.

Icon emoji

Specifies an emoji (using colon shortcodes, eg. :ghost:) to use as the profile photo alongside the message. If you would like to use custom emoji, see how to upload custom emoji and use the custom emoji name.

Channel

By default Slack sends notification to general channel. If you would like to override the channel, then input specific channel name in this field. Start channel name with # symbol.

Message

This field specifies the message body. The field is required.
You can use special placeholders to add more information about the release.
Use @channel in the text to mention everyone in the channel
Use {{setupName}} in the text to dynamically insert setup name
Use {{today}} in the text to dynamically insert the date of release notes sent
Use {{version}} in the text to dynamically insert release version
Use {{sprint}} in the text to dynamically insert sprint name

Send test notification

To make sure all settings are correct, click on “Send test message”. If you have any invalid data you will get validation errors. If all data is correct, a test message will be sent to your Slack chat.

Activate Slack notifications

Once you finish with settings, click “Activate” button, and if you have added all information correctly settings will be saved and notification will be activated. Now after each release, you start getting Slack notifications about release notes. Slack button will be highlighted after activation.

Deactivate Slack notifications

You can deactivate Slack notifications at any time. All settings will be saved after deactivation. No worries you don’t lose your settings. Then you can activate back Slack notifications any time again.

Microsoft Teams notification

If you use Microsoft Teams chat messenger, you can set up a notification to the chat room when release notes happened. The notification contains text and link to the generated release notes.

Click on the Microsoft Teams button on the Notifications block. Settings opened in popup.

Microsoft Teams settings

Once you click on Teams button, settings are opened. Let’s set up Teams notification.

Webhook URL

Use Teams documentation page about Incoming Webhooks to create Webhook and enter created Webhook to this field. If you already have the Webhook just use it. This field is required.

Message

This field specifies the message body. The field is required.
You can use special placeholders to add more information about the release.
Use {{setupName}} in the text to dynamically insert setup name
Use {{today}} in the text to dynamically insert the date of release notes sent
Use {{version}} in the text to dynamically insert release version
Use {{sprint}} in the text to dynamically insert sprint name

Send test notification

To make sure all settings are correct, click on “Send test message”. If you have any invalid data you will get validation errors. If all data is correct, a test message will be sent to your Teams chat.

Activate Teams notifications

Once you finish with settings, click “Activate” button, and if you have added all information correctly settings will be saved and notification will be activated. Now after each release, you start getting Teams notifications about release notes. Teams button will be highlighted after activation.

Deactivate Teams notifications

You can deactivate Teams notifications at any time. All settings will be saved after deactivation. No worries you don’t lose your settings. Then you can activate back Teams notifications any time again.

Confluence integration

If you use Confluence space you can set up integration with Confluence and get published each release notes automatically.

Click on the Confluence button on the Notifications block. Settings opened in popup.

Confluence settings

Once you click on Confluence button, settings are opened. Let’s set up Confluence integration.

URL

Enter your Confluence URL here. The field is required.

User name

Enter your Confluence user name. Usually, you use this user name to log in to Confluence. The field is required.

API Token

API Token is required to authenticate 3rd party scripts or services with an Atlassian cloud product. Check out Atlassian documentation on how to generate a new API Token. If you already have one then you can use it. The field is required.

Title

This field indicates the title of the published page. The field is required.
You can use special placeholders to add more information about the release.
Use {{setupName}} in the title to dynamically insert setup name
Use {{today}} in the title to dynamically insert release notes sent date
Use {{version}} in the title to dynamically insert release version
Use {{sprint}} in the title to dynamically insert sprint name

Type

You can determine the type of published content. There are two types “Page” and “Blog post”. The field is required.

Page – indicates content will be published as Confluence page
Blog post – indicates content will be published as Confluence blog post

Space key

Enter Space key you would like to publish content in. You can find the Space key in Space Settings. The field is required.

Parent page id

You can specify parent page id to set the published page as a child.

Activate Confluence integration

Once you finish with settings, click “Activate” button, and if you have added all information correctly settings will be saved and notification will be activated. Now after each release, you start getting release notes published in your Confluence space. Confluence button will be highlighted after activation.

Deactivate Confluence integration

You can deactivate Confluence integration at any time. All settings will be saved after deactivation. No worries you don’t lose your settings. Then you can activate back Confluence integration any time again.

Custom Webhook

If you have any 3rd party service and would like to get notification about release notes then you can use Custom Webhook to set up 3rd party integration.

Custom Webhook settings

Once you click on the Custom Webhook button, settings are opened. Let’s set up Custom Webhook integration.

Webhook URL

Here is the only option is URL. Enter any URL and the plugin will send POST request with JSON payload to the URL. The field is required.

Payload example

{payload: 'HTML content of the release notes'}

Activate Custom Webhook

Once you finish with settings, click “Activate” button, and if you have added all information correctly, settings will be saved and notification will be activated. Now after each release, you start getting release notes notification in your specified URL. Custom Webhook button will be highlighted after activation.

Deactivate Custom Webhook

You can deactivate Custom Webhook integration at any time. All settings will be saved after deactivation. No worries you don’t lose your settings. Then you can activate back Custom Webhhok integration any time again.

Logs

This page keeps the history of all your release notes. It displays sprint or release version, recipients, template format, sent date, status, and actions.
By clicking on template format you can download PDF or HTML file of the release note. If you see failed status you can resend release notes again.