This page shows you how to configure the SonarQube Connector for Jira Cloud. You can consult here how to configure Sonarqube Connector for Jira Server/Data Center: See Configuration for Jira Server/Data Center

Global Settings Configuration

You can configure a global server to share the configuration on all Jira projects. This is very useful if your Sonar instance is the same for all your Jira projects.

There are different options:

SonarQube Server URL: this is server base URL for your SonarQube installation
Token: this field is optional. If your SonarQube instance is not public, then you will need to setup this field with the security token from a SonarQube user.
The token type must be USER token type. You can find more information about SonarQube tokens here: Managing your tokens | SonarQube Server 10.7 | Sonar Documentation
SonarCloud Organization: this parameter is needed if you have configured SonarCloud as SonarQube Server URL.
Open AI Settings (Experimental) : Configuring this field will automatically add comments to Jira issues created by the application (3 comments max). These comments are suggestions for resolve the problem in code using the OpenAI API. If you dont have a token, you can generate it from here. Additionally, please note that the feature to use OpenAI's suggestions via the plugin is optional and it is disabled by default. Furthermore, you need to have your own OpenAI API key managed entirely by yourself.

Show history charts : you can enable/disable this option if you want to show history measure charts.
History date : you can select a date from which you want to obtain de history measures.
Group project cards : the number of of individual project cards displayed in the plugin panel.
Last analysis date warning : this option will show a warningn for projects with last analysis date befor this configured date in days (90 days by default).
Main Panel Screen : you can select which screen do you want to be main screen (Overview, CWE Top 25, OWASP Top 10, OWASP ASVS or ISO 5055).
Filter settings : Select which sonarqube issuetypes are displayed in sonarqube issuesbreakdown.

Jira Issue Labels : you can configure a list of labels, to add them to Jira issues created with Sonarqube Connector for Jira
Footer Image Url : You can add custom image url to add it to the PDF files created with Sonarqube Connector for Jira.

Project Level Configuration

The plugin configuration is quite simple. You can setup your SonarQube settings in your 5 JIRA project settings section:

Connection Settings

There are different options:

SonarQube Server URL: this is server base URL for your SonarQube installation
Token: this field is optional. If your SonarQube instance is not public, then you will need to setup this field with the security token from a SonarQube user.
The token type must be USER token type. You can find more information about SonarQube tokens here: Managing your tokens | SonarQube Server 10.7 | Sonar Documentation
SonarCloud Organization: this parameter is needed if you have configured SonarCloud as SonarQube Server URL.
Resource ID: Search and select one or more project, apps or portfolios.
Tags :This is an optional field. You can get the projects through the tags associated with them in SonarQube/SonarCloud. Search and select one or more tags. For SonarCloud, enter tags manually separated by commas.
Require all tags : enable this option if you want to retrieve the information from all projects that have exactly all configured tags.

Visualization settings

Show history charts : you can enable/disable this option if you want to show history measure charts.
History date : you can select a date from which you want to obtain de history measures.
Group project cards : the number of of individual project cards displayed in the plugin panel.
Last analysis date warning : this option will show a warningn for projects with last analysis date befor this configured date in days (90 days by default).
Main Panel Screen : you can select which screen do you want to be main screen (Overview, CWE Top 25, OWASP Top 10, OWASP ASVS or ISO 5055).
Filter settings : Select which sonarqube issuetypes are displayed in sonarqube issuesbreakdown.
Custom metrics: List of custom metric keys to display in the dashboard, you can specify 1 or a list of metric keys separated by commas. For example: blocker_violations, major_violations, classes. Check with your SonarQube administrator to find out the keys to the available metrics.

Issue creation settings

Issue type For Bugs: this is the default issue type to create new Jira issues based on SonarQube Bugs.
Issue type For Vulnerabilities: this is the default issue type to create new Jira issues based on SonarQube Vulnerabilities.
Issue type For Code Smells: this is the default issue type to create new Jira issues based on SonarQube Code Smells.
Issue type For Hotspots: this is the default issue type to create new Jira issues based on SonarQube Security Hotspots.
Jira Issue Labels : here you can configure a list of labels, to add it to the Jira issues created with Sonarqube Connector.
Add Jira issue key as comment in SonarQube issues: When an issue is created in Jira via the connector, the app can automatically add a comment to the SonarQube issue with a direct link to the created Jira issue. This allows you to quickly identify that the issue is already being managed in Jira and access the ticket with a single click.
Comment prefix: This allows you to customize the initial text of the comment published on SonarQube.If no value is specified, the default prefix [Jira] is used.

PDF settings

Footer Image Url : You can add custom image url to add it to the PDF files created with Sonarqube Connector for Jira.

Advanced settings

Open AI Settings (Experimental) : Configuring this field will automatically add comments to Jira issues created by the application (3 comments max). These comments are suggestions for resolve the problem in code using the OpenAI API. If you dont have a token, you can generate it from here. Additionally, please note that the feature to use OpenAI's suggestions via the plugin is optional and it is disabled by default. Furthermore, you need to have your own OpenAI API key managed entirely by yourself.