checks

README

wpt.fyi GitHub Checks integration

This directory implements the wpt.fyi (and staging.wpt.fyi) integration with the GitHub Checks API for commits made to WPT. The goal of this integration is to provide summary data (reporting regressions, etc) for test-suite runs performed by our CI systems (Azure Pipelines and Taskcluster).

The wpt.fyi GitHub Checks code owns only computing the summary data and pushing it to GitHub, not ingesting the results from the CI systems. For those, see the /api/azure and /api/taskcluster directories.

Links

• Design doc

Documentation

Index

• Constants
• func RegisterRoutes()
• type API
  • func NewAPI(ctx context.Context) API

Constants

const CheckProcessingQueue = "check-processing"

CheckProcessingQueue is the name of the TaskQueue that handles processing and interpretation of TestRun results, in order to update the GitHub checks.

Functions

func RegisterRoutes

func RegisterRoutes()

RegisterRoutes adds route handlers for webhooks.

Types

type API

type API interface {
	shared.AppEngineAPI

	ScheduleResultsProcessing(sha string, browser shared.ProductSpec) error
	GetSuitesForSHA(sha string) ([]shared.CheckSuite, error)
	IgnoreFailure(sender, owner, repo string, run *github.CheckRun, installation *github.Installation) error
	CancelRun(sender, owner, repo string, run *github.CheckRun, installation *github.Installation) error
	CreateWPTCheckSuite(appID, installationID int64, sha string, prNumbers ...int) (bool, error)
	GetWPTRepoAppInstallationIDs() (appID, installationID int64)
}

API abstracts all the API calls used externally.

func NewAPI

func NewAPI(ctx context.Context) API

NewAPI returns a real implementation of the API. nolint:ireturn // TODO: Fix ireturn lint error