Setting up Confluence
Background
Since Atlassian does not provide cross-application (Jira to Confluence) APIs, ARN needs you to store Confluence credentials in order to use 'Publish to Confluence' action.
Integrate Confluence with ARN on Jira Cloud
As Jira admin, go to App Menu from Jira settings >> Configurations under Automated Release Notes section >> Integrations tab >> click on Create Token under Confluence integration section.
Expected parameters here include -
Confluence URL
Username (this should be the same email address that you have used to login and to generate the API token key)
On click of Submit, the credentials will be saved only if they are successfully verified by the API Token key. If there is some kind of error, the data will not be saved. A relevant message will be displayed on the screen.
If Confluence credentials are not added, Confluence action will continue to show an error message. Following above givesteps will complete the basic Confluence integration.
If you are using DC or Server version of ARN and trying to connect your Cloud confluence -
On DC/Server version of Jira, you'll notice the Password field not the API Token, which is typically required for connecting to DC Confluence.
Atlassian has now updated its cloud applications to allow only the API tokens. Basic authentication (using password) does not work anymore. That is why for Cloud Confluence, you should generate an API token from the same user's Confluence login you're using in the integration settings. Insert this API token into the password field. Here's the link - https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/ to the help documentation that explains the steps to generate API tokens from cloud Atlassian login.
Important
Make sure that the account being used here has permission to create pages in the target Confluence for spaces intended to be used in the actions.
Our recommendation is - create an account specifically for ARN & provide it permission to create pages in those spaces of your Confluence where release notes will be published.
These credentials are stored in database. They are encrypted & can be decrypted only by the application.
Connecting multiple Confluence instances
It is possible to connect up to 3 Confluence instances with ARN. Just click on ‘Add Confluence instance’ and that will reveal an additional box, where relevant details can be added.
Impact on actions
Having multiple Confluence instances configured will mean that in the ARN actions, you can choose where the action will execute.
Removing a Confluence instance
By clicking on the Trash Icon, one can delete the already connected Confluence instance. But if the instance is already used in any of the rules, the delete action will fail. An error message will be displayed, that lists the name of the rule/s where the Confluence instance is in use.
Remove it from the rules/actions & then you’ll be able to remove the connected Confluence instance.
If you are looking forward to publish release notes in new Confluence editor, we have developed a https://marketplace.atlassian.com/apps/1230896/arn-confluence-helper-app?hosting=cloud&tab=overview. Please go through Checklist to Publish release notes (in new Confluence editor) using ARN Helper app to use this new approach.