Skip to main content
Use our GitHub Reporter app to see test run results in your GitHub: as comments on pull requests and commit status checks.

​
Pull request comments

Empirical posts a summary of test results as a comment on your pull requests. PR comments screenshot

​
Status checks

Empirical reports the status of test runs in commit status checks. Status checks screenshot

​
Get started

Pre-requisites: The GitHub Reporter requires test runs to be triggered from your CI/CD pipelines. Each test run trigger needs to have commit and branch info, so that it can be used for reporting.
  • If you are using our GitHub Actions, this is already done and there’s no action required
  • If you are using an API call, make sure to send the build object in the request payload
To install the GitHub Reporter:
  1. Navigate to the Integrations page
  2. Click “Install” on the GitHub app
  3. Choose the repository where you want to see the reports (this will be the repo where test runs are triggered from, either using the GitHub Action or API calls)

​
Permissions

The GitHub Reporter relies on the following two permissions only, and it does not need or have access to your app’s source code.
ScopePurpose
Read and write access to checksCreate and update status checks in GitHub
Read and write access to pull requestsCreate and update a comment for a pull request in GitHub