This version of the SonarQube documentation is no longer maintained. It relates to a version of SonarQube that is not active.
Ctrlk
Start Free
For the complete documentation index, see llms.txt. This page is also available as Markdown.

PDF reports

PDF reports give a periodic, high-level overview of the overall code quality and security for your projects, applications, and portfolios.

PDF reports are available as part of Enterprise Edition and above.

The content on this page is aimed at developers who want to get PDF reports and subscribe to updates. If you're an admin, see PDF reports in the instance administration section.

The PDF reports focus mainly on new code and quality gate conditions. This means that, if there are failing conditions on the overall code, they will appear in the report as well.

Depending on the configuration of your SonarQube Server instance, the PDF reports are generated with metrics either from Standard Experience or MQR mode.

Project and application PDF reports

You can download PDF reports for a permanent branch of a project or application and subscribe to regular updates. The frequency with which you receive reports is set by a project or system administrator. See Maintaining project branches for more information.

To download a PDF report for a project or application:

Navigating to downloadable reports

  1. Retrieve the project or application. See Retrieving projects for more information.

  2. On the Overview page, click on the Downloadable reports drop-down menu.

  3. Select Download Project report (PDF) or Download Application report (PDF). You can also Subscribe to monthly report.

You cannot download or subscribe to a PDF report for a temporary branch. If you are unable to download or subscribe to a PDF report for a branch, go to Your project > Branches and Pull Requests and make sure that the Keep when inactive toggle is on for that branch. You must be a project admin to do so.

Portfolio PDF reports

You can download a PDF report for a portfolio from the portfolio’s Overview page:

  • Click on the Downloadable reports drop-down menu.

  • Select Download Portfolio report (PDF). This is really convenient, for example, if you’re going into a meeting where you may not have access to your SonarQube Server instance.

You can also Subscribe to monthly report. The default subscription frequency is monthly, but a portfolio administrator can change it. See Managing portfolios for more information.

You will only receive the PDF when the portfolio is computed.

Related pages

PreviousViewing reports
NextSecurity reports

Last updated

Was this helpful?