Chapter 01

Quick Start & User Onboarding

Levee provides two simple onboarding paths for data engineering teams. Choose the method that best fits your infrastructure.

Option 1: 1-Minute GitHub Webhook Integration

Recommended (No Code Install Needed)

If your team already has a dbt project hosted on GitHub and a running DataHub instance:

  1. Navigate to your GitHub Repo → SettingsWebhooksAdd webhook.
  2. Payload URL: https://levee.yourdomain.com/api/webhook
  3. Content type: application/json
  4. Secret: Enter your configured GITHUB_WEBHOOK_SECRET
  5. Which events: Select Let me select individual events, check Pull requests, uncheck Pushes.

Done! Whenever any engineer or AI agent opens a dbt PR, Levee automatically intercepts it, traces DataHub lineage, posts review comments, and opens companion Fix PRs.

Option 2: Standalone CI/CD GitHub Action (`.github/workflows/levee.yml`)

For teams that prefer running checks inside existing GitHub Actions pipelines without hosting a web server:

name: Levee Pre-Commit Lineage Guard
on: [pull_request]

jobs:
  guard:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'
      - name: Run Levee Lineage Guard
        run: python -m agents.levee_agent
        env:
          DATAHUB_GMS_URL: ${{ secrets.DATAHUB_GMS_URL }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}