| Table of Contents |
|---|
Overview
...
Release management app has embedded functionality for release notes generator. User can define multiple release notes templates for versions and packages and use them for the notes generation.
Release notes templates support rich text formatting. Furthermore, data from version or package (such as version or package props, issues lists and etc.) could be automatically injected into the notes body.
Quick start guide
In order to generate your first release notes please follow a few simple steps:
Navigate to “Release notes” tab in the board menu
Click create template button:
Specify template name and save a template with a default body:
Click “Generates Notes“ button
Choose version from a list and click “Generates Notes“ button
Download generated release notes as HTML or upload to confluence
Release notes templates
Templates operations
...
User can change columns order.
Export options
Download as HTML
The output on Release Notes could be downloaded as HTML
...
You can use it to Copy/Paste into MS Word, Google Docs, Confluence and any other wiki with (almost) no changes to layout. See other options below plus Upcoming Features for more formats we plan to support shortly.
Upload to Confluence (Coming early 2021)
To substitute “Copy/Paste to Confluence” we implemented a direct integration with Confluence to upload into one of your available spaces.
...
Getting started
If you are using “Upload to Confluence” the first time and you have not used “Code/Commits“ functionality of our App (in other words you have not yet created an APIToken to connect to Atlassian Ecosystem) you will receive the following dialog while attempting to upload.
...
Click on the link to navigate to standard Atlassian APITokens generation page as shown below
...
Generate one and copy to clipboard
...
Now go back to Release Management App and specify your email connected with Atlassian account and past your token from the clipboard and click connect.
...
| Info |
|---|
We will keep this token in your cookies and you will be able to share same token between “Code/Commits“ functionality and “Upload to Confluence“. If you want to Revoke it navigate to Atlassian page to do so. |
Configuring the destination
If you already connected to confluence you will see the following dialog to help us define the destination to upload your release notes
...
You would need to specify
Confluence Space to shortlist the parent pages
Parent page - any selected page within the Space defined
Page title - you can define a custom name of use some of our release/package variables to include in the naming.
...
Click “Export“.
Navigating to Confluence
Once our App successfully uploaded your release notes to Confluence, the following confirmation will be shown
...
Click on the link specified to navigate to your release notes in confluence.
...
Upcoming features
Generate by schedule. User can define a schedule for release notes generation or connect it to some triggers. Such as moving version or release to a certain status etc.
Send over email. Release notes will be generated by a trigger and send to relevant recipients over email.Auto-publish to confluence. In addition to getting downloadable HTML the user could be able to automatically submit release notes to Confluence.
Add more formats of releases notes. PDF and DOC.
...