Skip to content
PerfLeaf Docs

GitHub Integration

PerfLeaf’s GitHub integration automatically triggers a new scan whenever a commit is pushed to your monitored branch. This means you always have a fresh performance report after each deployment.

Prerequisites

Section titled “Prerequisites”
  • A GitHub account
  • A repository containing your site’s code (or at least deployable to the site URL)
  • The site must already be set up in PerfLeaf

Connecting a repository

Section titled “Connecting a repository”

  1. Open Site Settings for the site you want to connect (/dashboard/settings/site/[id]).

  2. Scroll to Integrations → GitHub Repository and click Connect GitHub Repository.

  3. You’ll be redirected to GitHub to install the PerfLeaf GitHub App on your account or organisation. Grant access to the repositories you want to monitor.

  4. After installation, you’re redirected to the repository selection page in PerfLeaf.

  5. Select the repository and branch you want to monitor, then confirm.

  6. You’re redirected back to Site Settings where the connected repository, branch, and last commit SHA are now displayed.

What happens after connecting

Section titled “What happens after connecting”
  • PerfLeaf polls your repository every 5 minutes for new commits on the configured branch.
  • When a new commit SHA is detected, a scan is queued automatically.
  • The report is tagged with trigger type commit.
  • lastCommitSha is updated so the same commit doesn’t trigger a second scan.

Scan delay

Section titled “Scan delay”

In Site Settings → Crawl Settings, set a GitHub Scan Delay (in seconds) to wait after detecting a commit before starting the scan. This is useful if your deployment pipeline takes time:

  • Deployment takes ~5 minutes → set delay to 300
  • Deployment takes ~10 minutes → set delay to 600

Trigger on commit setting

Section titled “Trigger on commit setting”

The Trigger on Commit toggle in Crawl Settings must be enabled for commit-triggered scans to run. You can temporarily disable this without disconnecting the repository.

Disconnecting

Section titled “Disconnecting”

To remove the GitHub integration, open Site Settings → Integrations → GitHub Repository and click Disconnect. This removes the repository link from the site but does not uninstall the GitHub App.

To fully uninstall the GitHub App, go to your GitHub App settings and uninstall PerfLeaf.