This guide will show you how to securely connect SYNQ to your dbt source code by using GitHub’s deploy keys.We need this information so we can extract information about code changes to your dbt models and link these to your data assets to make debugging dbt models easier.To be able to finish this guide, you’ll need the following:
→ Access to GitHub
→ Admin Access to your dbt or Looker repository (only repo admins can add deploy keys).⏱️ Estimated time to finish: 10 minutes.

​
Access

We follow the least privilege principle and require read-only access limited to the selected repository that contains your dbt source code.**

​
Name your integration

For example dbt Cloud GitHub

​
Repository URL

The full URL of the Git repository that contains your dbt or Looker project (we only support SSH URLs).

​
Branches to analyze

SYNQ, by default, analyses a master and main branches. If you prefer for us to process the code from any other branch, provide the name.

​
Path to analyze

SYNQ, by default, looks for your source code in the root of the repository. If you store your code in a sub-directory, please provide us with a path (e.g., dbt/ if your dbt project uses dbt/ as a directory). In most cases, it is best to leave to use default to analyze everything in the repository.

​
Copy the Public key

Click Create to set up the Git integration and copy the Public key that SYNQ provides

​
Setup a deploy key

These steps will take you through how to set up a deploy key with the public SSH key we’ve provided you.
  1. In the upper-right corner of any GitHub page, click your profile photo, then click Your profile
title
  1. On your profile page, click Repositories, then click the name of your repository.
title
  1. From your repository, click Settings
title If you don’t see the settings tab you likely don’t have Admin Access to your dbt repository
  1. In the sidebar, click Deploy Keys, then click Add deploy key
title
  1. Provide a title, and paste the public key that SYNQ has provided you.
title Leave the Allow write access unticked
  1. Click Add key.
For more details, see the official guide on how to set up Deploy keys on GitHub.