Viewing regulatory reports

Starting in Enterprise, you can download a regulatory report for any permanent branch of a project. A permanent branch is one that has been set to Keep when inactive, see Maintaining your branches for details.

Downloading regulatory reports

To download a regulatory report:

1. Retrieve the project.
2. On the Overview page, click Downloadable reports and select Download Regulatory report (.zip) from the drop down menu.

Alternatively:

1. Select Project Information from the project’s navigation bar. 
2. In the Regulatory Report section, choose a project branch from the drop down menu.
3. Click Download report. 

SonarQube generates the report for download, which may take a few minutes depending on the size of the project.

Contents of the regulator report’s ZIP file

The reports are in a ZIP file containing a snapshot of the latest analysis of the selected branch and include TXT, CSV, and PDF files.

The PDF file includes:

• Project overview: 
  • Project details
  • Quality gates information and status
• Project rating overview for:
  • New code broken down by new issues, accepted issues, coverage, duplication, and security hotspots.
  • Overall code broken down by security, reliability, maintainability (in MQR Mode) or vulnerabilities, bugs, and code smells (in Standard Experience), accepted issues, coverage, duplication, and security hotspots.
• Distribution of issues in new code showing open issues and breakdown by severity, based on security, reliability, maintainability (in MQR Mode) or vulnerabilities, bugs, and code smells (in Standard Experience).
• Distribution of issues in overall code showing open issues and breakdown by severity, based on security, reliability, maintainability (in MQR Mode) or vulnerabilities, bugs, and code smells (in Standard Experience).
• Quality gate and quality profiles information.
• Files lists all relevant files included in the ZIP file.
• Definitions lists all the definitions of terms related to the report.

Depending on the configuration of your SonarQube Server instance, the regulatory report is generated with metrics either from Standard Experience or MQR Mode. Some CSV files may contain metrics from both modes and they are marked accordingly.

Related pages

• Viewing security reports
• Viewing PDF reports
• Viewing portfolios
• Issue with downloading regulatory reports