Guides

GitHub Integration Paid

xcelera integrates with GitHub to automatically report performance results as check runs on your pull requests.

Installing the GitHub App

  1. Go to Settings → GitHub in your xcelera dashboard
  2. Click Install GitHub App
  3. Select the GitHub organization and repositories you want to connect
  4. Authorize the installation

Once installed, the connection appears in your settings page.

How check runs work

When you trigger an audit with Git context (via the API or CLI), xcelera creates a GitHub check run on the associated commit:

  1. A pending check run appears on your PR
  2. As the audit runs, the check is updated to in progress
  3. When complete, the check shows the performance score and a summary of key metrics
  4. The check links back to the full audit report on xcelera

The check run includes:

  • Overall performance score
  • Key metrics: LCP, TBT, CLS
  • Comparison with previous audit results (when available)
  • A direct link to the detailed report

Check runs require Git context (owner, repo, branch, commit hash) in the audit request. The API & CLI guide shows how to pass this context.

Connecting repositories

The GitHub App needs access to each repository where you want check runs. You can manage repository access from your GitHub organization settings or from the xcelera GitHub settings page.

Disconnecting

To remove the integration, go to Settings → GitHub and click Disconnect. This removes the app installation — existing check runs on past PRs will remain but no new ones will be created.

Combine GitHub check runs with the API in a GitHub Actions workflow for fully automated performance checks on every PR.

Help