Investigate the GitHub checks API

[Manfred]

We're looking for a way to allow easy interaction between Perf Check and GitHub pull requests. It's possible that the checks API is a fit even though Perf Check is not a traditional CI service.

[Manfred]

• Can we link back to a useful view with the 'details' link in the checks summary? No

[Manfred]

The Details link always goes to the relevant check. In other words, this:

Links to this:

And View more details link on that page links to the details_url set for the check run.

[Manfred]

Other ideas of things you can create on a PR:

• Reactions: +1, -1, laugh, confused, heart, hooray, rocket, and eyes (can also be deleted)
• PR Reviews: "Things are faster!"

Unfortunately none of these allow you to easily link back to PerfCheck. The only ways to link back to PerfCheck seems to be to create or edit a Check or a Comment.

[sudara]

Hmmm, I wonder how CircleCI achieves their direct link to circleci.com from the checks interface?

[sudara]

Maybe they purposefully don't use the new checks API unless you opt-in to it: https://circleci.com/docs/2.0/enable-checks/

[sudara]

It might be helpful to separate these two needs:

1. Get notified of git pushes to a branch or PR that we care about, that may or may not contain metadata that can trigger a Perf Check Job

2. Find a way to advertise Perf Check on a PR to ease discoverability.

[Manfred]

Ah yes, the current way of implementing checks is by using the Status API. You register a webhook and then use the Status API to set a status for a commit sha. That has a target URL to link back to the CI. I'm guessing they'll show the statuses for the last commit in the PR.