Viewing PDF reports
PDF reports are available as part of the Enterprise Edition and above.
PDF reports give a periodic, high-level overview of the code quality and security of your projects, applications, or portfolios.
The 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.
To download a PDF report for a project or application:
- Retrieve the project or application.
- In the upper right corner of the project or application's Overview page, click Project PDF report or Application PDF report and select Download or Subscribe to report from the drop-down menu.
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 Project Settings > Branches and Pull Requests and make sure that the Keep when inactive toggle is on for that branch (you must be a project admin).
Portfolio PDF reports
You can download a PDF report for a portfolio from the portfolio’s Overview page by selecting Portfolio PDF report from the upper-right corner and clicking Download. 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 subscribe to receive a PDF by email by selecting Subscribe to report from the Portfolio PDF report drop-down menu. The default subscription frequency is monthly, but a portfolio administrator can change it.
You will only receive the PDF when the portfolio is computed.
Related pages
Was this page helpful?