Setting up Confluence
Background
Since Atlassian does not provide cross-application (Jira to Confluence) APIs, ARNR needs you to store Confluence credentials in order to use 'Publish to Confluence' action.
Integrate Confluence with ARNR on Jira Cloud
As Jira admin, go to Jira settings () >> Marketplace Apps >> Configurations under Automated Release Notes & Reports section >> Integrations tab >> Enter the Confluence site link >> Click on Connect your Confluence account button
For existing ARNR users
For existing users of the ARNR app, Jira admins should see the screen below to switch from Basic authentication to OAuth 2.0. Just click on Reconnect Confluence, select the relevant site and click on Accept.
Integrate Confluence with ARNR on JIra DC
Click on Jira admin settings >> Manage apps >> In the left side pane, look for Automated release notes & reports settings >> Integrations tab >> Update the Confluence credentials of the user with relevant permission to Confluence spaces.
Add the relevant details as shown in the image above. On the DC/Server version of the app, you'll notice the Access Token field, which is typically required for connecting to DC/Cloud Confluence.
Atlassian has now updated its applications to allow only API tokens. Basic authentication (using a password) does not work anymore. That is why 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. Below are the links to the help documentation that explains the steps to generate API tokens from the Atlassian login -
Cloud Confluence - https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
DC Confluence -
Using Personal Access Tokens | Enterprise Data Center Latest | Atlassian Documentation
Follow the API token generation steps based on whether you are connecting a Cloud/DC confluence instance with your DC ARNR app.
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 ARNR & 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.
For restricted Confluence instances
In certain scenarios, organizations may have restricted Confluence instances. To enable integration between their Confluence instances and a different application/system, they must include the IP addresses of that application in the allow list.
Listed below are ARNR’s outgoing IP addresses that you can incorporate into your allow list -
15.188.245.122
15.188.253.88
Should you encounter any challenges or have inquiries, please do not hesitate to contact us via our Service desk.
Connecting multiple Confluence instances
It is possible to connect up to 3 Confluence instances with ARNR. 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 ARNR 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 ARNR Helper app to use this new approach.