Skip to content

GitLab Next

Open
Created by Mark Pundsack@markpundsackContributor

Code quality report for default branch

Problem to solve

After release of #4189 (closed) Developers will be able to see a full code quality report in addition to the MR widget showing changes for the MR compared to the Master branch which solved a problem for Sasha.

Parker and Delaney would still like to have a view of the full code quality report outside of the context of a change so can make confident choices about feature development vs. tech debt payment with data.

From the initial writeup of the issue

Seeing code quality analysis on merge requests is awesome, but what about master (or other target branches)? How do we see the current code quality, or changes in quality for things pushed directly to master (which should never happen, right)? The same applies for a develop branch or other non-master branch where people may work directly.

Intended users

Further details

Use Cases

Sasha:

  • When I want to increase the code quality of a project, I need a full report of current code quality of any branch, so that I can quickly identify code that can be improved in quality AND deliver value to customers.

QE/SDET:

  • When I am looking for areas to test, I want a report of code quality deficiencies of any branch, so that I can write tests to find/fix software that will hinder value delivery to customers.

Benefits:

  • Provide easier access for any stakeholder to the code quality report outside of the context of an MR.

Goals:

Proposal

  • Provide an easily accessible page that provides a view/download of the accessible code quality report(s) for a project that are available.
  • Message when no code quality report is available for a branch about why and how to create one.

Permissions and Security

Action Guest Reporter Developer Maintainer Owner
View report of master x x x x
Download report of master x x x x
View report of any branch x x x x
Download report of any branch x x x x

Documentation

  • Update documentation to note that setting up code quality job will create this report, where it can be found and for how long

Testing

  • Report view gets reviewed by UX (mobile view is a stretch goal)
  • Report can be rendered in under 10 seconds on tab load
  • Expired reports cannot be downloaded

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

Success Metrics

  • Page views of the new report page

Acceptance Criteria:

  • Report view gets reviewed by UX (mobile view is a stretch goal)
  • Report can be rendered in under 10 seconds on tab load
  • Report can still be downloaded

What is the type of buyer?

The Buyer of this functionality is the QE Manager, Development Team Lead or Engineering Leadership.

Links / references

  • This should be able to build on #4189 (closed) previously delivered to show a full code quality report in the context of an MR.
Edited by 🤖 GitLab Bot 🤖