Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 30 Next »

Icon

Manual Reviews available since Sonar 2.8

Action Plans available since Sonar 2.13

The objective of the Manual Review feature is to be able to assign a violation to a user and start a discussion thread which should possibly lead to the correction of the violation.

Table of content

Review lifecycle

A review has four possible status : Open, Resolved, Reopened and Closed. Sonar automatically takes care of closing a review as soon as its underlying violation gets resolved, which means that no one can close an issue manually.

The first status of review is Open. From there a review can be resolved with one the the two resolution types : Fixed or False-Positive. At any point of time a Resolved review can be reopened either by the user or by Sonar. Indeed, if a review is marked as Resolved with resolution Fixed but the violation is still there after a new Sonar analysis, Sonar automatically reopens the review.

Reviews can be managed in action plans. 

Create a review

To create a review, you must be first logged in and have the Users role on the project containing the violation to review. Then, directly in the resource viewer, a new "Review" link appears to start creating a new review when placing the mouse over the violation title :

A comment must be filled before being able to really create the review by clicking on the "Add comment" button :

 

By default, a review is assigned to the creator of the review but the assignee can be changed or simply removed.

Once a review has been created on a violation, every Sonar user can see the review below the violation :


Only the last comment on a review can be edited by the creator of this last comment.

Flag a violation as false-positive

If a violation is a false-positive, this is pretty straight forward to switch off this violation by clicking on the "Flag as false-po

sitive" link :


Once a violation is switched off, this violation is no more displayed by default in the resource viewer. The option "False-Positives only" must be selected to display those false-positive violations :


Moreover, all measures on the project like the number of violations will be updated the next time a Sonar analysis will run. 

Reopen a Review

Once a review has been fixed or flagged as false positive, it's stil possible to reopen it at any point of time :


Search for reviews

The Reviews page allows to search for any review with optional filter parameters like the project, the author of the review, the severity of the violations, the status of the review,... :
By default, all reviews assigned to the current user are displayed.

Clicking on the title of a review allows to display the detail of this review :

Since Sonar 2.9, it's also possible to track false-positive reviews from this search engine :

Create an Action Plan

Action plans can be created to group reviews together.


Attach a Review to an Action Plan

An action plan can be associated to each violation.

Widgets

Sonar comes with several widgets that are specialized to display reviews information in dashboards. Those widgets are grouped in their own category in the dashboard configuration:

Here is the type of dashboard you can create to manage reviews:

 

  • No labels