DocsAPI & IntegrationGitHub Integration

Supported Packages

DocsAPI & IntegrationGitHub Integration

IntegrationsGitHub

GitHub Integration

Connect your GitHub repositories to push generated code and create pull requests.

Push Code

Push generated models directly to your repo

Pull Requests

Create PRs for code review workflow

Auto Sync

Sync changes when chonks are updated

Setting Up GitHub Integration

1Install the DataChonk GitHub App

Go to Project Settings and click "Connect GitHub". This will redirect you to GitHub to install the DataChonk app on your organization or personal account.

The app requests read/write access to repository contents and pull requests only for the repositories you select.

2Select Repository

Choose which repository to connect. This is typically your dbt project repository. You can connect multiple projects to different repositories.

3Configure Branch & Path

Set the default branch and base path for generated files:

Example configuration

{
  "repository": "org/dbt-project",
  "default_branch": "main",
  "base_path": "models/",
  "create_prs": true,
  "pr_branch_prefix": "datachonk/"
}

Push Workflow

Push from Web UI

After generating code for your chonks, click the "Push to GitHub" button. You can:

Push directly to your default branch
Create a new branch and push there
Create a pull request for review

Push from CLI

CLI push commands

# Push to default branch
datachonk push

# Push to specific branch
datachonk push --branch feature/new-models

# Create a pull request
datachonk push --pr --title "Add customer dimension models"

# Push specific chonks only
datachonk push --chonks dim_customers,fct_orders

# Dry run to see what would be pushed
datachonk push --dry-run

Pull Request Workflow

DataChonk can create well-formatted pull requests with all the information your team needs for review:

Example PR created by DataChonk

## DataChonk Generated Models

This PR was automatically generated by DataChonk.

### Changes
- Added `models/staging/stripe/stg_stripe__payments.sql`
- Added `models/marts/finance/fct_payments.sql`
- Updated `models/marts/finance/_finance__models.yml`

### Chonks Modified
| Chonk | Type | Status |
|-------|------|--------|
| stg_stripe__payments | staging | new |
| fct_payments | fact | new |

### Tests Added
- `stg_stripe__payments`: unique, not_null on payment_id
- `fct_payments`: unique on payment_key, relationships to dim_customers

### How to Review
1. Check the generated SQL matches business requirements
2. Verify test coverage is adequate
3. Run `dbt build --select +fct_payments` locally

---
*Generated by [DataChonk](https://datachonk.io) • [View Project](https://app.datachonk.io/projects/abc123)*

Permissions & Security

The DataChonk GitHub App requests minimal permissions:

Permission	Access	Purpose
Contents	`read & write`	Push generated code to repository
Pull Requests	`read & write`	Create and update pull requests
Metadata	`read`	List repositories and branches

Repository-Level Access

You choose exactly which repositories DataChonk can access during installation. You can modify this at any time in your GitHub settings. We recommend only granting access to your dbt project repositories.

Common Issues

Can't see my repository

Make sure the DataChonk app has access to the repository. Go to GitHub Settings → Applications → DataChonk → Configure to update repository access.

Push failing with permission error

Check that the default branch isn't protected, or create a new branch instead. If using branch protection, enable "Allow GitHub Apps to bypass" in branch rules.

PR not triggering CI

GitHub Apps create PRs that may not trigger workflows by default. Enable "Allow GitHub Actions to create pull requests" in your repository settings.

Webhooks