Integrations
Integration extends notification area by sending release notes to Slack, Microsoft Teams or any custom endpoint (Webhook).
Also, it is able to publish selected template content as a new page in Confluence on each release notes send.
Slack
You should set up the following fields to get notification to your Slack chat. Try "Send test message" button to make sure your settings are correct.
Webhook URL
Use Slack documentation of Incoming Webhooks in order to create one.
Incoming Webhhok is unique URL to which the Release Notes plugin sends notification.
User name
This is user name you get notification from in Slack. By default it is "Release Notes bot"
Icon emoji
This is user emoji icon you get notification from in Slack. Example of emoji :ghost: 👻
Message
Slack notification message. It supports the following variables
@channel- mentions everyone in the channel{{setupName}}- setup name{{releaseDate}}- date of release notes are sent{{version}}- released version name. Available when trigger is "Release of version"{{sprint}}- completed sprint name. Available when trigger is "Close of sprint"
Microsoft Teams
Microsoft Teams requires two fields to be set up to get notifications. Try "Send test message" button to make sure your settings are correct.
Webhook URL
Use Microsoft documentation of Incoming Webhooks
to create Webhook URL.
Incoming Webhhok is unique URL to which the Release Notes plugin sends notification.
Message
Microsoft Teams notification message. It supports the following variables
{{setupName}}- setup name{{releaseDate}}- date of release notes are sent{{version}}- released version name. Available when trigger is "Release of version"{{sprint}}- completed sprint name. Available when trigger is "Close of sprint"
Webhook
Use custom URL Webhook if you want to get release notes to any 3rd party service.
For example you have a blog and you want to create a post for each release notes.
Then set up your blog URL to get notifications from the Release Notes plugin.
Url example: https://myproject.com/blog/create-post
The plugin sends POST request to this URL with JSON payload
{ payload: 'HTML content of release note template is here' }
Confluence
Confluence integration allows you to publish content of generated template as a page or blog post on each release note is sent.
It requires the following fields to be set up.
URL
Your Confluence domain URL. Example https://myproject.atlassian.net
User name
Email you are using to login to Confluence
API Token
Use Atlassian documentation in order to create API Token for your account.
Title
Title of the Confluence page or blog post. It supports the following variables
{{setupName}}- setup name{{releaseDate}}- date of release notes are sent{{version}}- released version name. Available when trigger is "Release of version"{{sprint}}- completed sprint name. Available when trigger is "Close of sprint"
Type
Type of Confluence publish. Page or Blog post
Space key
The key of the Confluence Space where you want to publish release notes
Parent page id
Specify parent page id if you want to publish release notes as a child page