Checklist to publish release notes (in new Confluence editor) using ARNR Helper app
Background
Following Atlassian’s deprecation of Confluence’s legacy editor, we gradually depricated Confluence template that would publish release notes and reports in the legacy editor and introduced the New Confluence editor template. This is a new approach that allows you to create enhanced templates in Confluence.
To use this approach, users need to do a one-time setup that involves a few steps. -
Install our free app helper app that connects ARNR, Jira, and Confluence https://marketplace.atlassian.com/apps/1230896/automated-release-notes-reports-helper-for-confluence?hosting=cloud&tab=overview (It is a Confluence app)
Integrate Confluence with ARNR & connect the ARNR free helper app that you installed initially.
Start publishing release notes and reports to Confluence
Check the video below to understand all the integration steps, or refer to the written steps mentioned in the sections below this video
Step 1 - Install Automated Release Notes & Reports Helper for Confluence
As a Confluence administrator, navigate to Manage apps settings within your Confluence Apps menu
Click on Find new apps / Manage apps
Search for ARNR Confluence Helper App
Install the app
Step - 2 Integrate Confluence with ARNR and connect free helper app
As a Jira admin, navigate to Jira admin settings ( ) and click on Marketplace apps >> In the left navigation notice Automated Release Notes & Reports app under a small Apps section >> click on Integrations tab >> click on +Add Confluence instance option available at the top, and notice the Confluence integration section gets added on the page.
This step establishes a connection between Confluence, Jira, and ARNR. If you do not follow this step, ARNR Confluence Helper will still work, and you will be able to use this feature. However, that will not allow you to have easy JQL suggestions while creating Confluence templates, and it is quite error-prone unless you are sure the JQLs that you are adding is 100% correct.
To avoid any such issues, it is recommended to complete this step. More details in the section.
If you are first time user, you need to click on +Add Confluence instance. If you have already integrated Confluence as an existing user, then your instance is already added; you only need to follow the steps below once navigated to the integrations tab.
Now, click on the " Connect your Confluence account button (in case of existing users, it will be “update your Confluence account“; click on it)
This will open a new tab to authenticate the connection (via OAuth2). Verify and Accept the connection.
Navigate back to the earlier Integrations screen of the ARNR app in Jira and click on Create Token (for existing users, the option would be Regenerate token)
Copy the token
This completes one part of the integration! Let us now move on to complete the other part in your Confluence instance.
This step establishes a connection between Confluence, Jira, and ARNR. If you do not follow this step, ARNR Confluence Helper will still work, and you will be able to use this feature. However, that will not allow you to have easy JQL suggestions while creating Confluence templates, and it is quite error-prone unless you are sure the JQLs that you are adding is 100% correct.
To avoid any such issues, it is recommended to complete this step. More details in the section below.
Update the token in the Confluence Helper app
As a Confleunce admin, navigate to Settings () >> in the left navigation under the Configurations section, click on Configure ARNR Confluence Helper App.
Paste the token copied from the Jira integration tab and Save/Update
If you have integrated multiple Confluence instances with ARNR, please make sure you are generating the token for the relevant Confluence instance where you have the ARNR Confluence Helper App installed.
Now, copy the created token
If your setup that is explained in the above section (Integrate Confluence with ARNR), is not completed, you would not see the Create token option for the helper app.
Please note that this token would be able to fetch Jira data within the Confluence helper app for features like JQL suggestions. Data fetched against different Jira fields depends on the user's credentials used for configuration. For example, if user A's credentials establish the connection between ARNR and the ARNR Helper app, User B, who might not have access to all the Jira projects that user A has, will still be able to see relevant Jira data in JQL suggestions.
Once you have completed this, you are all set to publish release notes with the new Confluence editor. Below are the steps -
Step 3 - Start publishing release notes and reports to Confluence