CI Custom Output integration in MergeRequest Widget and CI e.g. for lighthouse

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Problem to solve

  • Display custom build results in merge request and pipeline view
  • Integrate lighthouse and other tools in merge request view and pipeline view

Target audience

Further details

  • Most Teams have custom workflows, which are currently solveable with tools, which export junit und the current junit merger
job:
  artifacts:
    reports:
      junit: "junit.phpcs.xml"

Proposal

image

  • I would expect, that we can add content via an defined api endpoint or artifact.
job:
  artifacts:
    reports:
      html: "htmlReport.json"

Additionally i would specify a json file like:

{
  'title': 'Reportname which is displayed in MR Widget',
  'reportUri': 'Link to artifact, might be external',
  'reportIcon: 'favIcon, either base64 or external', 
  'reportAbstract': '<html>...</html>',
  'reportContent': '<html>....</html>',
  'success': true
}

The result is then either displayed at position 1️⃣ or at position 2️⃣ . This way gitlab is easily extensible for any kind of report.

field content required
title title for mr widget yes
reportUri uri for linking external sources for the report no
reportIcon uri or base64 encoded image no
reportAbstract html abstract for the first toggle of the mr widget line no
reportContent html / alternativ to reportUri no
success boolean, decides if job was successfull yes

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

Links / references

Edited by 🤖 GitLab Bot 🤖