GoogleChrome/lighthouse-ci

Report GitHub check status differently when highest failing assert is a warning

Open

#375 ouverte le 8 juil. 2020

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)JavaScript (5 965 stars) (658 forks)batch import
P3enhancementgood first issue

Description

I've currently set a assert profile like this:

module.exports = {
  ci: {
    ...
    assert: {
      ...
      assertions: {
        "categories:performance": "warn",
        "categories:best-practices": "warn",
        "categories:seo": "warn",
        "uses-long-cache-ttl": "off",
        "uses-http2": "off"
      }
    }
  }
}

What I get on github is this:

The message is fine, but having a success conclusion makes the checks panel to auto-collapse, so users won't be attracted to it at all. Maybe we should use neutral or find another way to improve that, but without failing the check?

Guide contributeur

Stack technique
javascriptnodejs
Domaine
ci cddevopstooling
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
half day
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Node.jsGitHub Checks API basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40
Direction de recherche
The issue requests changing the GitHub check conclusion from 'success' to 'neutral' when all failing asserts are warnings. Investigate the assertion logic in the lighthouse ci codebase, likely in the 'assert' module. Look at how the check run is created and where the conclusion is set. Consider using the GitHub Checks API to update the conclusion to 'neutral' while keeping the overall check as passing. Refer to the existing implementation and the GitHub API documentation for check runs.