Code Quality report in notification emails

Description

We should include code quality reports in notification emails, both for branches to indicate improvements/degradations, and for overall quality of master (if you've subscribed to success notifications).

The full code quality report might not make as much sense when there are errors, or at least the failures should be the focus of the notification. Perhaps eventually we should be smarter about code quality and only report initial report on first pipeline run, and then changes +/- over time, or when an alert-worth change happens.

For branches, we won't send notification emails on subsequent successes, but perhaps we should know if code quality has degraded and alert on that, both in the UI and in email. Maybe consider it success-with-warning, and notify on warnings?

But specifically, for the first-push scenario, we should include the full report on first push of master (once we start notifying on first pipeline) and for branches, we should include the delta report.

Proposal

  • Include whatever code quality report we have, at notification time (e.g. include full report for first push of master, include delta report for subsequent pushes/branches).

This would probably be a summary with a link to the pipeline's Code Quality report / the Merge Request page to show the report content as it could be a lengthy email with 100's of lines.

Screenshot_2020-07-07_10.18.27

Links / references

Documentation blurb

Overview

What is it? Why should someone use this feature? What is the underlying (business) problem? How do you use this feature?

Use cases

Who is this for? Provide one or more use cases.

Feature checklist

Make sure these are completed before closing the issue, with a link to the relevant commit.

Edited by James Heimbuck