Jira Cloud
Understanding the SonarQube Cloud integration with Jira Cloud.
The Jira Cloud integration is available in the Team and Enterprise plans.
To set up the SonarQube Cloud integration with Jira Cloud, see Connecting your organization to Jira Cloud.
Key features
The Jira Cloud integration allows SonarQube Cloud users to push issues into Jira as work items. A Jira widget is used in SonarQube Cloud to manage in a centralized way the connected Jira work items for a project.
Jira widget
The SonarQube Cloud project’s Main Branch Summary page shows a widget with the number of Jira work items of the earliest unreleased version of the connected Jira Cloud space that are not yet completed. Users can navigate via the widget to this list of open work items in Jira Cloud.
The following applies:
If two or more unreleased versions of the Jira Cloud space have the same date or have no assigned date, the widget will select the version with the lowest release ID, which is the release that was created first.
Any open Jira work item linked to this version is taken into account, regardless of whether they are associated with SonarQube issues or not.
If the connected Jira Cloud space doesn’t use the release concept, the widget will not be able to show information and will raise a warning.
Jira work item creation
A user can push a SonarQube issue to Jira Cloud and thus create the corresponding Jira work item with the work type they selected. They can also push multiple issues (up to 500) to the same Jira work item.
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 Cloud organization admin who connected the organization to Jira Cloud (see Jira Cloud below).
Solution overview
The SonarQube Cloud app for Jira Cloud is used to manage the integration. SonarQube Cloud will access Jira Cloud through this app.
The connection between SonarQube Cloud and Jira Cloud occurs at the following levels:
Organization: Your SonarQube Cloud organization is connected to your Jira Cloud instance.
Project: A SonarQube Cloud project is connected to a Jira Cloud space.
Issues: When a user pushes one or several issues to Jira, the app creates the corresponding work item in the connected Jira Cloud space and both are connected.
Organization-level integration
The SonarQube Cloud organization admin connects their organization to their Jira Cloud instance by authenticating to the instance using their Atlassian account. This step results in the installation of the SonarQube Cloud app for Jira Cloud in the instance. The connection is based on the Atlassian account of the SonarQube Cloud organization admin:
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 Cloud organization access to the Jira Cloud instance through the app.
Project-level integration
Once your SonarQube Cloud organization 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 Cloud 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.
SonarQube Cloud doesn’t support all Jira work types. For more information, see Connecting your project to Jira Cloud.
Security
The SonarQube Cloud app for Jira Cloud is a OAuth 2.0 3LO App 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 Cloud organization admin 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.
All Jira operations performed from the SonarQube Cloud organization are performed on behalf of the organization admin's Atlassian account. When users connect a project or push issues, they might see Jira spaces and create Jira work items in spaces where they lack permissions in Jira Cloud. To mitigate this security concern, only organization administrators are allowed to connect SonarQube Cloud projects to Jira by default.
Related pages
Last updated
Was this helpful?