Setup takes about 15 minutes.
Introduction
Use the GitHub Enterprise Server connector when you want Foundational to access source code in a self-hosted GitHub Enterprise Server deployment.
To make the connection, you need to:
Install and register the Foundational GitHub App on your GitHub organization.
Grant Foundational access to GitHub Enterprise Server repositories.
Prerequisites
Ensure you have:
Access to GitHub Enterprise Server
Organization owner permissions to register a GitHub App
If your GitHub Enterprise Server is restricted, add Foundational IP addresses to the allowlist, see the article Allowing IP access to Foundational.
Access permissions
Access to GitHub Enterprise Server allows Foundational to determine data lineage and analyze pending and historical pull requests. Permissions are granted through the GitHub app registered on your GitHub Enterprise Server.
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 Enterprise Server
In Foundational, open the Connectors & Integrations page.
In Source Control, select the GitHub Enterprise Server card and click Connect.
Click Add Server.
The Set Up New Connection screen opens.
Enter the details:
Server URL: Enter the URL. Make sure it is accessible from Foundational servers.
GitHub Organization Name: The name of the GitHub organization where you installed the Foundational GitHub app.
Click Next.
The Grant repository access to Foundational screen opens. Click Register App.
You are redirected to your GitHub Enterprise Server to register the Foundational app.
Once the app is registered, you’re ready to connect Foundational to your GitHub Enterprise Server repositories.
Connect Foundational to GitHub repositories
Repeat the steps in this section for each GitHub source you want to connect.
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 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 Foundational should 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 Enterprise Server, ready to start analysis and data lineage.