Status Checks

Status checks are supported for integrations using the Emerge GitHub app.

Setup

Checks are used to report the size change and performance test results of each pull request. They require the SHA of your branch build to match the SHA of the latest commit on your pull request.

🚧

If you're not seeing a check

Verify the commit SHAs match, sometimes CI will build with a merge commit instead of the latest commit to your PR branch.

States

Checks can be in one of 5 possible states:

  • Processing
  • Errored
  • Timed Out
  • Successful
  • Action Required

A build enters processing as soon as it finishes uploading, and will timeout if it's been in processing for more than 10 minutes.

17401740

Successful Emerge status check

A successful size analysis status check will show the total size, absolute size change and relative size change for a PR. The details of the check will show you the full breakdown of the diff as well as a treemap overview of what changed in your PR.

A successful performance analysis status check will show the relative performance between the head commit of your PR and the base commit. This information includes the percent change and its confidence interval.

Action Required

Note that Action Required status checks currently only available for size analysis. If you are interested in enabling the Action Required state for performance testing, please reach out!

If you want to require extra confirmation before merging large PRs you can enable an action required threshold from your app settings on the profile page.

19121912

When the percentage size change of a PR is above this threshold the status check will require developers to press an "I Understand" button before the check turns green.

18921892

Errors

Errors indicate that there was an issue performing analysis of your build. Errors can usually be resolved by inspecting the details of the error message. Here are some common errors and how to resolve them:

Missing base build

This will happen if the base SHA of your PR doesn't have a corresponding upload. The base SHA Emerge looked for will be included in the status check details. As a first step, verify this matches the base branch of your PR, then make sure your base builds are uploading.

No artifact found

If we couldn't find a build artifact in your upload this most likely means the uploading structure is wrong. Double check the right file was uploaded, and not a sub folder or parent folder of your build artifact. A full list of Emerge supported artifacts can be found here.