Setup guide

Self-serve setup takes about a minute for your account. GitHub import runs in the background after you finish. This guide walks through each step and what to do if something looks wrong.

• Know your GitHub organization login (the slug in github.com/your-org).
• Have permission to install the DeliveryCompass GitHub App on that org, or create a personal access token with read:org and repo scopes as a fallback.
• Understand that import is statistics only — PR and review metadata, not source code. See what we import.
• You can register with email and password or Sign up with GitHub when your primary GitHub email is public.
• Plan a few minutes after setup to assign repositories to teams — team KPIs stay empty until you map repos.

Most teams use the DeliveryCompass GitHub App. Use a PAT only if you cannot install the App.

Create a classic or fine-grained personal access token with read access to your organization and repositories:

• read:org — list teams and organization repositories
• repo — read pull requests, reviews, and PR metadata (read-only is sufficient)

Paste the token under Advanced on Profile → GitHub. If validation fails, see troubleshooting: GitHub connection invalid.

Account creation is immediate. After you finish setup with a valid GitHub App install or PAT, the worker runs a bootstrap import of full PR history — typically minutes for small orgs, longer for large histories.

Organization-level metrics may appear before team cards populate. Team KPIs need both bootstrap progress and repo mapping.

Daily syncs refresh roughly the last 90 days; see sync schedule.

After import completes, open Teams & repos. Drag repositories from the unassigned pool onto team cards. Team KPIs only include mapped repos.

See the Teams & repos guide for mapping rules.

For step-by-step fixes (empty dashboard, GitHub connection issues, login problems, stale metrics, and more), see the troubleshooting guide.