Jira Cloud

Understanding the SonarQube Server integration with Jira Cloud.

circle-check

Key features

The Jira Cloud integration allows SonarQube Server users to push issues into Jira Cloud and thus create the corresponding Jira work item with the work type they selected.

circle-info
  • It's not possible to push a SonarQube issue to an existing Jira work item.

  • A user cannot push the same issue to multiple Jira work items.

A Jira work item includes the following information for each connected issue:

  • Title of the connected SonarQube issue.

  • SonarQube issue link.

  • Location of the issues.

  • File path.

  • Code lines.

  • Commit hash.

  • Date the issue was introduced.

  • Information about why this is an issue and how to fix it with the rule name and link.

  • Impact on software quality and severity.

The reporter for the Jira work item is the SonarQube Server instance administrator who connected the SonarQube instance to Jira Cloud (see Jira Cloud below).

Solution overview

An OAuth integration app that you have to create in the Atlassian developer console is used to manage the integration between SonarQube Server and Jira Cloud. SonarQube Server will access Jira Cloud through this app.

The connection between SonarQube Server and Jira Cloud occurs at the following levels:

  • Instance: Your SonarQube Server instance is connected to your Jira Cloud instance.

  • Project: A SonarQube Server project is connected to a Jira Cloud space.

  • Issues: When a user pushes an issue to Jira, the app creates the corresponding work item in the connected Jira Cloud space and both are connected.

The Jira Cloud integration occurs at three levels: instance, project, and issues. The SonarQube app for Jira Cloud acts on behalf of the account used to set up the instance connection.

Instance-level integration

The SonarQube Server instance administrator connects their SonarQube instance to their Jira Cloud instance by authenticating to the instance using their Atlassian account. This step results in the installation of the SonarQube Server app for Jira Cloud in the instance. The connection is based on the Atlassian account of the SonarQube Server instance administrator:

  • This account becomes the default reporter of the Jira work items that will be created on pushing SonarQube issues.

  • This account is used to grant the SonarQube Server instance access to the Jira Cloud instance through the app.

Project-level integration

Once your SonarQube Server instance has been connected to your Jira Cloud instance, a user with the corresponding permission within your organization can connect their project to a Jira Cloud space within the instance. The connection is done through the SonarQube Server app for Jira Cloud.

The connection setup defines the list of Jira work types users will be able to choose from when pushing issues to Jira.

circle-info

SonarQube Server doesn’t support all Jira work types. For more information, see .

Security

The SonarQube Server app for Jira Cloud is a OAuth 2.0 3LO Apparrow-up-right and thus, allows secure authentication via a standard 3LO flow.

If the app is not used for more than three months, its access authorization will expire. In that case, the SonarQube Server instance administrator must reauthorize the Jira Cloud connection through their Atlassian account. Note that the access authorization of the app can be manually removed from the organization admin's Atlassian account.

circle-exclamation

Last updated

Was this helpful?