This version of the SonarQube documentation is no longer maintained. It relates to a version of SonarQube that is not active.

See latest version
Start Free
8.9 | User guide | Portfolios

Portfolios

On this page

Portfolios are available starting in Enterprise Edition.

Portfolios home page

The portfolio home page is the central place for managers and tech leads to keep an eye on the releasability of the projects under their supervision. Releasability is based on the portfolio's projects' quality gates. Each portfolio home page offers an aggregate view of the releasability status of all projects in the portfolio.

At the top of the page, you can see the overall releasablilty of the portfolio, a graph showing the releasability trend, and the number of project branches that are failing and passing their quality gate.

The reliability, security vulnerabilities, security review, and maintainability ratings show the overall health of the portfolio on both new code and overall code.

Below the new code rating for each metric, you'll see how many are doing well and how many project branches are at risk.

Below the overall code rating will be a graph showing the trend for each metric. Additionally, the number of at risk project branches will be available here.

Releasability rating

The releasability rating is the ratio of projects in the portfolio that have a passed quality gate:

A: > 80%
B: > 60%
C: > 40%
D: > 20%
E: <= 20%

Reliability, security vulnerabilities, security review, and maintainability ratings

The reliability, security vulnerabilities, security review, and maintainability ratings for a portfolio are calculated as the average of the ratings for all projects included in the portfolio.

SonarQube converts each project's letter rating to a number (see conversion table below), calculates an average number for the projects in the portfolio, and converts that average to a letter rating. Averages ending with .5 are rounded up resulting in the "lower" of the two possible ratings, so an average of 2.5 would be rounded up to 3 and result in a "C" rating).

This gives a "problem density" measure on the four axes of reliability, security vulnerabilities, security review, and maintainability for your portfolio.

Rating conversion:

E: 5
D: 4
C: 3
B: 2
A: 1

Note: the Portfolio home page is also available at the sub-portfolio level

Portfolio PDF report

On a portfolio home page, you can download a PDF overview of the portfolio by selecting Download as PDF from the upper-right corner. This is really convenient, for example, if you're going into a meeting where you may not have access to your SonarQube instance.

You can subscribe to receive a PDF by email by selecting Subscribe from the "Portfolio PDF Report" dropdown. You can set the frequency of the report at the portfolio and global levels to dailyweekly, or monthly. The default frequency is monthly.

Note: You will only receive the PDF if the portfolio is computed.

Portfolios are created and edited in the global Portfolio administration interface: Administration > Configuration > Portfolios. For more information, see Managing Portfolios.


Was this page helpful?

© 2008-2024 SonarSource SA. All rights reserved. SONAR, SONARSOURCE, SONARQUBE, and CLEAN AS YOU CODE are trademarks of SonarSource SA.

Creative Commons License