Start Free
Latest | User guide | Issues | Managing issues

Was this page helpful?

Managing issues

On this page

In SonarQube, you can change the status of an issue in the following cases (see also Issue life cycle):

  • If you want to fix the issue later, you can accept an issue. The issue status is then marked as Accepted.
  • If you think the analysis is mistaken, you can mark it as False positive, provided you have the corresponding permission.

In addition, you can reassign an issue, tag an issue, and comment on an issue.

Accepting an issue

You may accept an issue if you
decide to fix the issue later.
Note that SonarQube ignores accepted issues in the quality reports and ratings of the code.

The procedure below explains how to accept a single issue. To accept several issues at once, see Managing several issues in bulk.

To accept an issue:

1. Retrieve the issue as described above in Retrieving issues (it’s not necessary to open the detail view). 

2. In the issue card, select the Open issue status and select Accept in the contextual menu as illustrated below. A Status change comment box appears.

3. Enter your change comment (optional) and select Resolve. The issue status is changed to Accepted.

Marking an issue as False positive

If the analysis is mistaken, you can mark an issue as False positive provided you have the Administer Issues permission on the project. Note that SonarQube ignores False positive issues in the quality reports and ratings of the code. 

The procedure below explains how to mark a single issue as False positive. To mark several issues at once, see Managing several issues in bulk

To mark an issue as False positive:

  1. Retrieve the issue as described above in Retrieving issues (it’s not necessary to open the detail view). 
  2. In the issue card, select the Open issue status and select False positive in the contextual menu. A Status change comment box appears.
  3. Enter your change comment (optional) and select Resolve. The issue status is changed to False positive.

Reopening an issue

You can reopen an Accepted issue (when it’s time to fix it) or a False positive issue (if it turns out to be a true positive).

The procedure below explains how to reopen a single issue. To reopen several issues at once, see Managing several issues in bulk

To reopen one or several issues:

  1. Retrieve the issue as described above in Retrieving issues (it’s not necessary to open the detail view).
  2. In the issue card, select the Accepted or False positive issue status and select Open in the contextual menu. The issue status is reset to Open.

Marking an issue as reviewed

To mark issues as reviewed, you may use the tagging feature: create the Reviewed tag and assign it to reviewed issues: see Tagging an issue. This way, you can filter the reviewed issues by using the Tag filter.

Assigning an issue

When possible, SonarQube assigns a default assignee at issue creation time (see Automatic issue assignment for more information). You can assign an unassigned issue to a user, reassign an issue to another user, or unassign an issue. 

The procedure below explains how to assign a single issue. To assign several issues at once, see Managing several issues in bulk

To assign an issue:

  1. Retrieve the issue as described above in Retrieving issues (it’s not necessary to open the detail view). To filter the unassigned issues, select Not assigned in the Assignee filter. 
  2. In the issue card, click the assignee name or the Not assigned mention. The list of users to whom you can assign the issue appears. 
  3. In the list, select the new assignee (or select Not assigned in the list to unassign the issue).

Tagging an issue

You can create tags and assign them to issues in order to retrieve issues more easily or to indicate a workflow step. For example, you can use a tag to mark an issue as reviewed. The figure below shows how tags are displayed in the issue item.

The procedure below explains how to tag a single issue. To add or remove a tag to/from several issues at once, see Managing several issues in bulk.

To manage the tags assigned to an issue:

  1. Retrieve the issue you want to manage as described in Retrieving issues.
  2. In the search results list or in the detail view, select in the Tags section if the issue. A dialog opens with the list of existing tags.
  3. In the dialog, you can use the search field to search for an existing tag. To create a new tag, enter the new tag in the search field: the new tag will appear in the list of tags with a plus sign in front of it .
  4. To assign or unassign a tag, select or clear the tag’s checkbox in the list.
  5. Click anywhere outside the dialog to close the dialog.

Commenting on an issue

When accepting an issue or marking an issue as False positive, you can add a comment. You can also add a comment to an issue anytime. These comments are visible from the Activity tab of the issue: see Viewing the issue management history and comments

By default, comments are shared between all users (it can be disabled at the global level). 

To add a comment to an issue:

  1. Retrieve the issue and open its detail view as described in …
  2. Open the Activity tab.
  3. Select Add a comment. The “Add a comment” dialog box opens.
  4. Enter your comment and select Comment.
  5. Your comment is added to the Activity tab.

Suppressing the issues on a given line

In most languages, you can use the //NOSONAR comment at the end of a line to suppress all issues on the line. This will suppress all issues - now and in the future - that might be raised on the line. 

Managing several issues in bulk

To manage several issues at once:

1. In the list of filtered issues, select the issues you want to manage:

    • To select one issue, select the issue check box.
    • To select all issues, select the Bulk change check box. Issues you do not want included in your action can be individually unselected.

2. Select the Bulk change button. The Change issues dialog opens.

3. In the dialog, select the action you want to perform:

    • Assign: to assign the issues to the same user.
    • Add tags: to add the same tag to the issues.
    • Remove tags: to remove the same tag from the issues.
    • Change status: to reopen the issues, accept the issues, or mark the issues as False positive.

4. Click Apply.

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

Creative Commons License