How to download a SonarQube PDF report from Jira: Step-by-step guide

Prerequisites

Before downloading a SonarQube PDF report from Jira, make sure you meet these requirements:

1 - Check that SonarQube Connector for Jira is installed

The app must be installed on your Jira Cloud instance. Follow these steps to install it:

• Sign in to your Jira instance as an administrator.
• Go to administration and then Marketplace apps.
• Click Find new apps (Explore apps).
• Search for "SonarQube Connector for Jira" and select the app.
• Choose Try free or Buy now and select the instance where you want to install the app.
• You can also install the app directly from the Atlassian Marketplace.

2 - Configure the SonarQube Connection

Next, configure the connection to SonarQube Server or SonarQube Cloud and the corresponding credentials. Follow these steps to configure the connection:

• Open your Jira instance, go to Settings, and select Marketplace apps.
• In Jira’s left sidebar, find Global Configuration under SonarQube Connector for Jira in the app list. The screenshot below shows where to find it.
• On the page that opens, enter your SonarQube Server URL or SonarQube Cloud credentials.
• Enter your access token (personal access token) from SonarQube to authenticate the connection.

3 - Link your projects

The Jira space where you want to use SonarQube Connector for Jira must be linked to at least one SonarQube project to display its data. Follow these steps to set up the link.

• In Jira’s left sidebar, open the space where you want SonarQube Connector for Jira data to appear.
• In the settings page, select Apps in the left sidebar, then click SonarQube.
• In the Connection settings section, you can use the SonarQube instance from the global configuration or configure a different instance by selecting or clearing "Check this option if you want to override global connection configuration".
• In the Project Settings, enter the key of the SonarQube project whose data you want to display. Then click Save.
• Once configuration is complete, open the SonarQube tab in your Jira space to view data from the linked project.

How to generate and download a PDF report step by step

Follow these steps in your Jira space to download SonarQube reports.

1. Open your Jira project

Open the SonarQube tab in your Jira project.

2. Open the SonarQube connector panel

From this tab, you can download an Overview report containing your project’s main code quality metrics. To generate the PDF, click Download.

3. Download security-specific reports

To download security-specific PDF reports, scroll down in the SonarQube tab to the Security Reports section.

The following security reports are available to download as PDFs:

• CWE Top 25: a security report that identifies the most dangerous software weaknesses in the code, based on the CWE Top 25 list. It helps detect and prioritize issues that could compromise application security.
• OWASP Top 10: a report for analyzing project vulnerabilities related to the ten most critical web application security risks identified by OWASP.
• OWASP ASVS: a security assessment report based on the OWASP Application Security Verification Standard (ASVS), helping teams review application security requirements and controls.
• ISO 5055: a code quality and security report based on ISO/IEC 5055, used to assess software weaknesses related to security, reliability, performance, and maintainability.

4. Review the downloaded report

Open the PDF to review the data and share it with anyone who needs to assess the project’s quality or security status.

How to customize the logo in PDF reports

SonarQube Connector for Jira also lets you configure the company logo displayed in the footer of reports. You can apply this setting globally to reports from all projects or configure it separately for each space.

1 - Global Configuration for All Reports

• In Jira, go to settings and select Marketplace Apps.
• In the left sidebar, select SonarQube Connector for Jira global configuration.
• Scroll down to PDF report sSettings at the bottom of the page and enter the URL of the logo you want to display in report footers.

2 - Configure the report logo for a specific space

• In the left sidebar, click the three-dot menu for the space you want to configure and select Project settings.
• In the left sidebar, select Apps and then SonarQube.
• On the PDF tab, select Override Global PDF Config and enter the URL of the logo image you want to display in report footers for that space.

Administrator permissions may be required to change these settings.