GoogleChrome/lighthouse-ci

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

Open

#375 opened on Jul 8, 2020

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (658 forks)batch import
P3enhancementgood first issue

Repository metrics

Stars
 (5,965 stars)
PR merge metrics
 (No merged PRs in 30d)

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?

Contributor guide

Research direction
Inspect the code that creates GitHub check runs and modify the conclusion based on the highest severity (error vs warn) of failed assertions.
Tech stack
javascriptnodejs
Domain
backendci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75