Connecting your organization to Jira Cloud

To integrate SonarQube Cloud with Jira Cloud, you must first connect your SonarQube Cloud organization with your Jira Cloud instance.

The Jira Cloud integration is available in the Team and Enterprise plans. For more information about this integration, see Jira Cloud.

Before you start

circle-info

Before setting up the connection to Jira Cloud, we recommend that you read first Jira Cloud.

To connect your SonarQube Cloud organization to your Jira Cloud instance, you must be an admin of the organization. During the setup, you will authenticate to Atlassian (if not already done). You must use an Atlassian account that:

  • Is a member of the Jira Cloud instance to be connected.

  • Is a member of the existing and future projects to be connected within that instance with the following permissions: read:jira-work, manage:jira-configuration, write:jira-work.

circle-info

The Atlassian account used to connect your SonarQube organization to your Jira Cloud instance becomes the default reporter for all Jira work items created from this organization.

1

Connect your SonarQube organization to your Jira Cloud instance

  1. Retrieve your organization. For more information, see Retrieving your organizations.

  2. Go to Administration > Organization settings > Jira.

Select the Connect button to connect your SonarQube Cloud organization with a Jira instance.
  1. Click Connect. You will be redirected to the Atlassian authorization page for 3rd party vendors. Follow the instructions and if you have multiple Jira Cloud instances, make sure to select the right instance.

To complete the SonarQube -to- Jira connection, select Accept in the SonarQube Jira Authenticator window.
  1. Click Accept to authorize the connection. You are redirected back to SonarQube Cloud.

2

Allow project admins to connect their project

If you want to enable project administrators to connect their projects to Jira, you must first enable the corresponding option within your SonarQube Cloud organization.

circle-exclamation

To allow project admins to connect their project to Jira Cloud:

  • Select the Grant project administrators binding permissions option in the Administration > Organization settings > Jira page.

Select the Grant project administrators binding permissions option.

The project admins within your organization can now connect their SonarQube projects to Jira Cloud spaces. See Connecting your project to Jira Cloud for more information.

Reauthorizing the connection to Jira Cloud

You may have to reauthorize the connection of your SonarQube Cloud organization to your Jira Cloud instance in the following cases:

  • The administrator who performed the connection has left your organization.

  • In the unlikely event that your organization doesn’t use any features of the Jira Cloud integration for three months (for example, if there are no projects connected for a given organization), the connection to Jira will expire.

Reauthorizing your organization is non-destructive, which means that connections to all projects and issues will remain intact.

circle-exclamation

To reauthorize your organization connection to Jira Cloud, you must be an admin of the organization. Proceed as follows:

  1. Go to Your Organization > Administration > Organization settings > Jira.

  2. Click Reauthorize.

Click the Reauthorize button.

Deleting the connection to Jira Cloud

By deleting the SonarQube to Jira Cloud connection, you will:

  • Lose access to all Jira features in this SonarQube Cloud organization.

  • Delete this organization’s project to Jira Cloud space connections.

  • Disconnect all SonarQube issues from Jira work items.

circle-exclamation

To delete your organization connection to Jira Cloud:

  1. In SonarQube Cloud, go to Your Organization > Administration > Organization settings > Jira.

  2. Select the delete icon.

  3. In your Atlassian account (the account used to connect your organization to Jira), remove the access for the SonarQube Cloud app:

  4. Open the Connected apps tab of the Atlassian account and navigate to the app.

  5. Select Remove access and confirm.

Select the Remove access button.

Troubleshooting

The following are the typical errors that might prompt you to troubleshoot the connection to Jira:

  • The administrator who set up the connection has left the company and the Atlassian token has been removed. Solution: The new administrator has to reauthorize the Jira connection at the organizational level. See Reauthorizing the connection to Jira Cloud for more information.

  • The connection has been reauthorized with a wrong Jira instance. Solution: Make sure to select the correct Jira instance on the Atlassian authorization page when reauthorizing the Jira connection at the organization level. SonarQube remembers previous issue-to-Jira work item connections on the project levels, but the organization has to be reauthorized to the original Jira instance for these connections to be available again. See Reauthorizing the connection to Jira Cloud for more information.

  • Some Jira work types cannot be selected on the project settings page for Jira. Solution: Jira work types that have other mandatory fields associated with them are not supported and are disabled in SonarQube. You can either remove these mandatory fields in Jira or choose a supported work type in SonarQube.

Other issues:

  • The Push to Jira button is not visible on the SonarQube issue page. Solution: After connecting your organization to a Jira instance you need to connect individual SonarQube projects to Jira spaces. See Connecting your project to Jira Cloud for more information.

  • The Jira release widget does not show any insights, even though your team is operating under a version-based release cycle. Solution: Ensure you have releases and versions enabled in your Jira space. See more on Atlassian’s webpagearrow-up-right.

Last updated

Was this helpful?