GitHub App
Sync eval suites from a repository without long-lived PATs
Connect a GitHub App so ShipGauge can pull suite files and react to pushes with short-lived installation tokens.
When to use
- Suites live in-repo and you want dashboard sync
- You prefer App installations over PATs
One-click registration (recommended)
- Project → Settings → Integrations
- Register GitHub App (one-click) and approve on GitHub
- Install GitHub App on the target repository
- Enter
owner/repo/ branch / suites path
Credentials are stored on the workspace and encrypted when INTEGRATION_SECRETS_KEY is set.
Manual App (self-host / advanced)
Create a GitHub App with:
| Field | Value |
|---|---|
| Homepage | your app URL |
| Setup / callback | {APP_URL}/api/github/app/callback |
| Webhook | {APP_URL}/api/webhooks/github |
| Permissions | Contents: Read & write |
| Events | push, installation |
Set GITHUB_APP_ID, private key, slug, and GITHUB_WEBHOOK_SECRET in the server environment.
Security
When GITHUB_WEBHOOK_SECRET is set, ShipGauge verifies X-Hub-Signature-256. Uninstall events clear installation ids from projects.
PAT fallback
A classic PAT remains supported; saving a new PAT clears the App installation link for that project.
Verify
Trigger a sync from Integrations or push to the suites path; suites appear under Evaluations / suite list.