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. 

Jira administrators will be able to see the 'Configurations' page under Administration → Add-ons → Automated Release Notes section. Expected parameters here include - confluence url, username & password. On click of submit, the credentials will be saved only if they are successfully verified by the API. If there is some kind of error, the data will not be saved. Relevant message will be displayed on screen.

If Confluence credentials are not added, 'confluence action' will continue to show error message.

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.

Cloud version only 

Recently Atlassian has updated its cloud applications to allow only the API tokens. Basic authentication (using password) does not work anymore. API tokens can be generated from your Atlassian account - follow these steps. Thus for the Cloud version of Confluence, use the generated API token in place of password.

Connecting multiple Confluence instances

It is possible to connect upto 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, delete action will fail. An error message will be displayed, that lists 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.