Nits on check suite/run naming

web-platform-tests / wpt.fyi

web-platform-tests dashboard

https://wpt.fyi/

Other

190 stars 89 forks source link

Nits on check suite/run naming #850

Open foolip opened 5 years ago

foolip commented 5 years ago

https://github.com/web-platform-tests/wpt/pull/14351/checks has one check suite and 4 runs. It looks like a bug that there are 4 runs instead of 2, but ignoring that I have some nits on the naming:

"check" in the suite name is sort of redundant, can we call it "wpt.fyi results" or even just "wpt.fyi"?
For each run, can we call it the browser name, either just "Chrome" and "Firefox", or alternatively "Chrome Dev" and "Firefox Nightly"?

lukebjerring commented 5 years ago

To have more friendly (but less semantic) names for the checks, we'd need to store a CheckRun entity in our datastore. GitHub's CheckRun entity has an external_id field, so we could easily tie their instances to ours, and then store any special configuration information in the entities our end.

foolip commented 5 years ago

We currently use "chrome" and "chrome[experimental]". There's code that turns "chrome" into "Chrome" already. In order to turn "chrome[experimental]" into "Chrome Dev" we would need to know that it's Dev and not Canary, and strictly speaking we don't know that without assuming things about the CI system setup. But this is probably already true for "chrome[experimental]", so maybe we can just map it to "Chrome Dev" with no CheckRun entity?

I'm reminded of https://github.com/web-platform-tests/wpt.fyi/issues/611, but suspect it won't help at all, since we need to pick a name before we have results.

foolip commented 5 years ago

Here's what https://github.com/web-platform-tests/wpt/pull/14596/checks?check_run_id=42986549 looks like:

And this is what is looks like in https://github.com/web-platform-tests/wpt/pull/14596:

The name of the CI is included in the check run names as well. However, https://github.com/foolip/wpt/runs/42565087 shows what the upcoming GitHub Actions will look like, which doesn't have a built-in prefix:

Cirrus CI also does not: https://github.com/foolip/safari-ci-starter-kit/runs/28081748

(I started pasting screenshots thinking I'd changed my mind about what I'd like to suggest in this issue, but then I changed it back. Still pasting the screenshots though.)