Include timing details in GitHub Status Check

I’d love to see my actual timing numbers (in milliseconds for FCP and TTI) in my GitHub status checks like I can with the categorical scores. I use the Lighthouse CI integration for GitHub to see how my changes affect my site’s speed and just recently moved from using the basic “category” assertions to paying specific attention to my FCP and TTI times. I’ve added warn and error for my short-term goal and my current threshold for acceptable, but I want to see the progress I’m making without fishing through my build output/log in the GitHub Actions screens.

I’d love to be able to configure the message presented by the GitHub status check with richer information than just pass, pass w/warnings, or fail. See screenshot below for an idea of what I’ve got in mind.

I’ve considered looking into a bot to add a comment for every build, but that seems noisy. I also considered using a separate Lighthouse server to track my results, but I want the output right in my pull request. Since I could see the category scores, now I’ve got this idea the same kind of thing is possible for performance timing events.

Current:

Idea:

[patrickhulce]

Thanks for filing @ianjmacintosh! What if LHCI just directly exposed the ability to have a javascript function customize the description? Several people have had several conflicting opinions over the years about what this message should say 😃

Usage would look something like…

lighthouserc.js

module.exports = {
  ci: {
    upload: {
      githubStatusDescription({url, assertionResults, state}) {
        return `Whatever you want: ${assertionResults.map(result => /* ... */)}
      }
    }
  }
}

[patrickhulce]

Feel free to go for it @ianjmacintosh! I imagine the trickiest parts are going to be just documenting it accurately since it will require a javascript config in order to work 😃