Merge Preflight Docs
Start Policies Integrations Billing Troubleshooting
Setup

Getting started

Log in with GitHub

  1. Open `/login`.
  2. Choose GitHub.
  3. Complete the GitHub OAuth prompt.
  4. After sign-in, open `/admin`.

Install the GitHub App

  1. Install the Merge Preflight GitHub App on the target organization or repository.
  2. Approve either Issues: Read and write or Pull requests: Read and write so Merge Preflight can publish PR summary comments.
  3. Grant repository access only for repositories you want Merge Preflight to evaluate.
  4. Return to `/admin/repositories` and confirm your repositories appear.
  5. Use Refresh permissions if repository metadata is stale.
  6. If a check reports a provider denial even though access is already granted, use the GitHub status, message, and documentation URL in the warning, then inspect the server log for the complete redacted validation details and diagnostic headers rather than retrying blindly.

Enable a repository

  1. Open `/admin/repositories`.
  2. Find a repository where your GitHub permission allows settings changes.
  3. Use Subscribe or Adjust subscription to add a Direct subscription or Microsoft Marketplace repository license if no active entitlement exists.
  4. Open Settings and enable Merge Preflight enforcement after the entitlement is active.

Shared repository administration

Repository settings belong to the repository, not to the first user who configured it. Any signed-in user with GitHub-confirmed edit access can see and edit the same Merge Preflight settings.

When the UI shows `Enabled by teammate`, the repository is enabled through another admin's active subscription entitlement. You can see status details, but private payer management links are shown only to the payer when available.