Skip to main content

Overview

You can connect GitHub repositories in two ways:
  • Install the Coalesce Quality GitHub App on your GitHub organization, then pick the repositories to analyze.
  • Create a Git integration and add its public SSH key to the repository as a read-only deploy key.
Both give Coalesce Quality the commit history it needs. A repository connected either way can be selected as the Git integration of a dbt Core or SQLMesh integration.

Install the GitHub App

The GitHub App asks for read-only access: repository contents, metadata and Actions. It also receives push and workflow_job events, so Coalesce Quality analyzes new commits soon after a push.
  1. In Coalesce Quality, go to Settings > Integrations and select GitHub.
  2. GitHub opens the app installation page. Select your organization and the repositories the app can access, then install it. You need to be a GitHub organization owner, or have an owner approve the request.
  3. GitHub returns you to Coalesce Quality. On the GitHub integration page, add the repositories you want to analyze from Available repositories.
  4. Open a configured repository to set the branches and path to analyze and to turn Store commit diffs on or off. These settings work the same way as in the Git integration form.
The rest of this page describes the deploy key option.

Deploy key

Before you start: Create your Git integration first by following the integration form instructions. You’ll need the public SSH key from that integration.

Prerequisites

  • Access to GitHub
  • Admin access to your repository (required to add deploy keys)
  • Public SSH key from your Git integration
⏱️ Estimated time: 5 minutes

IP Whitelisting (If Required)

If your GitHub organization uses IP allow lists, add the Coalesce Quality egress IP addresses for your region. See IP Whitelist for the complete list. For instructions on adding IP addresses to GitHub, see GitHub’s guide on managing allowed IP addresses.

Adding the Deploy Key

Follow these steps to add the public key as a deploy key to your GitHub repository.
  1. In the upper-right corner of any GitHub page, click your profile photo, then click Your profile
    Navigate to profile
  2. On your profile page, click Repositories, then click the name of your repository
    Select repository

Access Repository Settings

  1. From your repository, click Settings
    Repository settings
If you don’t see the Settings tab, you likely don’t have admin access to the repository. Contact your repository administrator to add the deploy key.

Add the Deploy Key

  1. In the sidebar, click Deploy Keys, then click Add deploy key
    Add deploy key
  2. Configure the deploy key:
    • Title: Enter a descriptive name (e.g., Coalesce Quality Integration)
    • Key: Paste the public key from your Git integration
    • Allow write access: Leave this checkbox unchecked
    Configure deploy key
Do not grant write access. Coalesce Quality only requires read-only access to your repository.
  1. Click Add key to save the deploy key. Coalesce Quality can now read the repository.

Troubleshooting

Deploy key not working

  • Verify the complete public key was copied (including the ssh-rsa or ssh-ed25519 prefix)
  • Ensure the deploy key was added to the correct repository
  • Confirm write access is disabled (unchecked)

Connection refused

  • Check that your GitHub organization’s IP allow list (if configured) includes the Coalesce Quality egress IPs
  • Verify the repository SSH URL is correct in the integration form

No Settings tab visible

  • Confirm you have admin access to the repository
  • Organization owners may need to adjust access permissions

Additional Resources