Skip to content

Don't show rules marked as 'Ignore' in Code Quality reports

Problem to solve

As a developer, I want code quality reports to ignore rules marked as False Positives in my project, so I can fix actual code quality issues quickly without the mental load.

Intended users

  • Sasha (Software Developer) - who today just remembers which things to ignore but this leads to ignoring a lot of issues on accident.

User experience goal

Users of GitLab who have enabled code quality can mark specific rules as "something to ignore in the future" within a project. After that presentation of code quality issues (MR widget, full report) will ignore that line.

Proposal

  • Users can mark rules to ignore in an interface (full code quality report maybe, or code quality on default branch interface) that includes rules currently set to ignore so they can be re-enabled.
  • Presentation of code quality results will then parse out those rules from the view so user mental load is reduced.

Further details

A specific customer use case we have heard is the need to ignore a rule per file. That rule may be applicable in other parts of the code base.

Permissions and Security

Documentation

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

The team lead who wants to enforce usage of code quality but not bother them by constantly seeing violations they have decided not to fix. This feature helps the team manage that project workload so is at the GitLab Starter tier.

Is this a cross-stage feature?

It will not impact but will be influenced by the UX the Secure team built for interacting with vulnerabilities.

Links / references

https://gitlab.my.salesforce.com/0016100000SEhjw?srPos=1&srKp=001

  • feedback: Mark false positives as "Won't Fix" forever. For example, if the scan is flagging a like as having "Error X" when we know that it's a false positive, we'll mark that particular rule as "Won't Fix" for that line, and the scanner will never warn us about it again - not on the master branch or any branch.
Edited by James Heimbuck