Add a package for wpt.fyi GitHub Checks #726
Conversation
|
Staging instance deployed by Travis CI! |
|
Staging instance deployed by Travis CI! |
api/checks/routes.go
Outdated
| // RegisterRoutes adds route handlers for webhooks. | ||
| func RegisterRoutes() { | ||
| // GitHub webhook for creating custom status checks. | ||
| shared.AddRoute("/api/webhook/status", "api-webhook-check", checkWebhookHandler) |
There was a problem hiding this comment.
The inconsistency between the two strings is confusing. Is it a (legacy) status or a check?
There was a problem hiding this comment.
It's a check, and that's what the endpoint should be (Fixed).
|
|
||
| // checkWebhookHandler listens for check_suite and check_run events, | ||
| // responding to requested and rerequested events. | ||
| func checkWebhookHandler(w http.ResponseWriter, r *http.Request) { |
There was a problem hiding this comment.
This function looks very similar to the one in taskcluster.go, which is fine for now, but it'd be good to add a TODO to point out the potential refactoring opportunity.
There was a problem hiding this comment.
Already underway; See #721
api/checks/suites.go
Outdated
| } | ||
|
|
||
| // PendingCheckRun loads the CheckSuite(s), if any, for the given SHAs, and creates a pending | ||
| // check_run for the given browser name for each CheckSuite. |
There was a problem hiding this comment.
Clarify the return value (i.e. whether a new run is created; also explain when it will create a run).
api/checks/suites.go
Outdated
| } | ||
|
|
||
| // CompleteCheckRun creates a complete check_run for the given browser on GitHub, | ||
| // for the given CheckSuite |
api/checks/suites.go
Outdated
| return &suite, err | ||
| } | ||
|
|
||
| // GetSuitesForSHA returns any CheckSuite entities associated with the given SHA. |
There was a problem hiding this comment.
IIRC, the convention is to put the documentation for exported methods on the public interface?
api/checks/webhook.go
Outdated
| claims := &jwt.StandardClaims{ | ||
| IssuedAt: now.Unix(), | ||
| ExpiresAt: now.Add(time.Minute * 10).Unix(), | ||
| Issuer: "19965", |
There was a problem hiding this comment.
This magic number is unfortunate, but at least we should have a comment here.
Description
Adds the main logic needed to create basic
in_progressorcompletedGitHubcheck_runs.