Main Branch Analysis

Main branch analysis is your third line of defense in keeping your code clean (after SonarLint in your IDE and pull request analysis).

SonarCloud analyzes the main branch every time a change is made to it. Select My Projects in the global navigation and select your project from the list to see the results. By default, the Project Overview is displayed. This view includes three sections:

  1. Main Branch Status: The quality gate status of your main branch, PassedFailed, or Not Computed.
  2. Main Branch Evolution: A summary of the code quality results for the main branch of your project.
  3. Latest Activity: A summary of recent analyses performed on your project.
image description

On the left side of the page, go to Main Branch to see a detailed breakdown of the results for the main branch of your project.

image description

Quality gate

The quality gate status for your main branch is displayed under the Summary tab of the Main Branch view.
It shows the releasability status of the main branch of your project, answering the question, "Can I release my project today?"

A quality gate consists of a set of conditions like "Reliability is rated at least A", "Maintainability is rated at least B", and "Test coverage is at least 80%". These conditions are applied to analysis results to determine whether the code meets the level of quality required.

If the main branch meets or exceeds the quality gate conditions, it displays a Passed status:

image description

If the main branch does not meet the quality gate conditions, it displays a Failed status:

image description

Setting a new code definition

Initially, when you start a new project, you may end up performing an analysis without first setting a new code definition. Selecting a new code definition for your project is an essential part of setting up SonarCloud.
Without one, the default quality gate won't work. In this case, the system directs you to set up your new code definition, like this:

image description

What counts as new code can differ from project to project, so SonarCloud provides a few options. We strongly encourage all users to choose a new code definition suitable for their project.

Once you have set up a new code definition and performed another analysis, the quality gate status should appear.

Built-in quality gate

SonarCloud provides a built-in quality gate (called the Sonar way quality gate) enabled on the main branch by default. This quality gate reflects SonarSource's recommended settings. However, your requirements may differ, so you may wish to define a custom quality gate. For details see the Quality Gates section.

New code quality measures

When you first look at a newly analyzed project, it can be challenging to decide where to start fixing issues. To help with this, SonarCloud encourages you to focus your efforts on new code. This is why we encourage users to set a suitable new code definition for their project.

We refer to this practice as Clean As You Code. The Clean As You Code approach emphasizes focussing on issues in recently changed code, helping you to catch and fix errors before they become entrenched.

To help you focus on recently changed code, the main branch summary displays a specific tab for new code quality measures (4, below).

image description

This is the most crucial section to focus on when fixing issues identified by SonarCloud!

Note that the new code quality measures (and any quality gate that relies on them, like the default quality gate) will only appear upon the second analysis performed after a new code definition has been set.

Overall code quality measures

In addition to new code quality measures, the main branch summary also displays the overall code quality measures in another tab. This tab shows the issues found in all code, including new code. This information is helpful but usually of secondary importance when employing the clean as you code methodology.

Measures categories

The measures themselves are displayed as tiles corresponding to the following categories:

  • Reliability: Details of bugs detected.
  • Maintainability: Code smells detected, as well as on the technical debt and debt ratio.
  • Security: Vulnerabilities needing immediate attention.
  • Security Review: Security-sensitive hotspots needing review.
  • Coverage: Displays the percentage of potentially testable lines of code that are actually covered by test cases. The lines of code that could be covered are referred to as the lines to cover. Of those lines to cover, those that are currently not covered are referred to as the uncovered lines. The coverage percentage calculation is, therefore: coverage = 100 - (100 * uncovered_lines / lines_to_cover). Note that lines to cover only counts lines that are included in the coverage report and testable (for example, lines that are only composed of } are not counted). This differs from how duplicated lines are counted. For more details see Test Coverage.
  • Duplications: Identical lines of code detected. All lines of code into account (including non-testable lines). Since this differs from how coverage lines are counted, the final count for the two metrics may differ.

Clicking on any figure takes you to a more detailed view, either in the Measures tab or the Issues tab.

Other tabs

image description

The Issues tab provides an overview of all the issues detected by the analysis and lets you filter the list by adjusting the facets on the left.

image description

The Measures tab shows all project metrics. Choose a measure for more details. Both list and tree views are available for each measure, and tree maps are available for percentages and ratings.

image description

The Code tab takes you to an outline of your project structure. Drill down to see files in a directory, and choose a file to see its code. If your project is too large for easy exploration via drilling down, the search feature on this page lets you search within the files and directories in the current project.

image description

The Activity tab takes you to the full list of code scans performed on your project since it was created in SonarCloud. Here you can follow the evolution of the quality gate, see the changes of quality profiles and find out when a given version of your code has been scanned.

Visualizations allow you to compare project components and quickly spot the ones that represent the most significant risks. Several predefined visualizations are available. You can also create custom ones with the metrics of your choice.

If you are a project administrator, the Administration menu gives you access to all project-level settings.

image description

The Information page provides additional details on various aspects of your project.

image description

Other analysis views

In this section, we looked at how the results of main branch analysis are displayed. In addition, you can also access the results of other branch analyses and pull request analyses through the project navigation on the left side of the screen.

image description

For details on these topics see the Branch Analysis and Pull Request Analysis sections.

© 2008-2023, SonarCloud by SonarSource SA. All rights reserved.