Setup takes about 10-15 minutes.
Introduction
Use the Foundational GitHub connector when you want Foundational to access source code in your GitHub repositories and build lineage.
To make the connection, you need to:
Authorize Foundational to access the GitHub repositories in your GitHub organization.
Prerequisites
Ensure you have:
Permissions to install or request installation of a GitHub App
Repository administrator approval for any repository Foundational needs to access
Access permissions
Access to GitHub allows Foundational to determine data lineage and analyze code changes, including pending and historical pull requests. Permissions are granted by authorizing the Foundational GitHub App on the repositories you select.
Foundational requires access so it can:
Read commits and pull requests
Track and analyze changes that affect data lineage
Comment in GitHub and perform CI (Continuous Integration) checks on pull requests
Connect Foundational to GitHub repositories
Repeat the steps in this section for each GitHub source you want to connect.
In Foundational, open the Connectors & Integrations page.
In Source Control, select the GitHub card and click Connect.
Click Add Organization.
The initial setup screen opens. Click Start Setup.
The Set Up New Connection screen opens. Select GitHub from the dropdown. Do not select GitHub Enterprise Server.
Click Next.
To grant Foundational access to your repositories, click Configure in GitHub.
A sign-in screen opens to install the Foundational GitHub app. Click Sign in.
GitHub opens in a new browser tab. Select the organization where you want to install the Foundational GitHub app.
Select the repositories that you want Foundational to access.
We recommend you select all repositories owned by the data team, such as dbt, Spark, Airflow, Upstream ORMs (e.g., TypeORM, Entity Framework, Eloquent), etc.
Click Update access.
The next screen lists the organizations with access and those pending approval.
Admins receive an email from GitHub asking them to approve access to their repositories. Once approved, the connection to that organization is complete.
That’s it. Foundational is now connected to GitHub, ready to start analysis and data lineage.