Skip to main content

GitHub

Zingle connects to GitHub to read your dbt repositories and to propose changes as pull requests. GitHub is how every change Zingle makes reaches your project.

Requirements

  • A dbt project hosted in a GitHub repository.
  • Permission to install a GitHub App on your GitHub organization (an administrator action).
  • Each user connects their personal GitHub identity so their commits and PRs are attributed to them.

Access needed

Zingle accesses GitHub through a GitHub App installation plus per-user OAuth. The App is granted:

PermissionLevelWhy
ContentsRead & writeClone the repo; commit agent changes to a branch
Pull requestsRead & writeOpen and update pull requests
MetadataReadList repositories and branches

Grant the App access to only the repositories Zingle should work with.

What it enables

  • Read your dbt project - clone it and parse the dbt manifest to build the catalog.
  • Write proposed changes to a dedicated branch.
  • Open and update pull requests for your review.
  • After a PR merges, a sync refreshes the catalog to match your default branch.

What it can't do

  • Zingle does not merge pull requests and does not push directly to your default/main branch. See the Production safety model.
  • Zingle works only with repositories you've granted the App access to.

Common setup issues

  • Repository not listed when adding a repo. The GitHub App may not have access to it - update the App's repository access in your GitHub organization settings.
  • PRs not attributed to you. Make sure you've connected your personal GitHub identity, not just installed the org-level App.
  • Branch/subdirectory not found. Confirm the branch name and, for monorepos, the subdirectory where the dbt project lives.