GitHub

This article outlines the integration with the GitHub connector, enabling streamlined metadata management through features such as crawling and lineage building (both automatic and manual). It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category	ETL
Connector Version	Release6.3.4
Releases Supported (Available from)	Release5.3
Connectivity [How the connection is established with GitHub]	REST APIs
Verified GitHub Version	2022-11-28 and Latest

The GitHub connector validates with the listed “Verified GitHub Version” and supports other compatible GitHub versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.

Connector Features

Feature	Availability
Crawling	✅
Delta Crawling	❌
Profiling	❌
Query Sheet	❌
Data Preview	❌
Auto Lineage	✅
Manual Lineage	✅
Secure Authentication via Credential Manager	✅
Data Quality	❌
DAM (Data Access Management)	❌
Bridge	✅

Metadata Mapping

The following objects are crawled from GitHub and mapped to the corresponding UI assets.

GitHub Object	GitHub Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
File	File From Source	Code Name	Codes	File

Set up a Connection

Prerequisites

The prerequisites to establish a connection:

Service Account User Permissions

It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.

👨‍💻Who can provide these permissions? The GitHub administrator grants these permissions, since users may not have sufficient access to assign them.

Operations	Objects	Access Permissions
Crawling	All files under the selected path/repository	Read Only

Add or Remove Objects based on the Connector object types.

Connection Configuration Steps

Users must have the Connector Creator role to configure a new connection.

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for GitHub, and complete the required parameters.

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name	Description
Connector Type	By default, "GitHub" is displayed as the selected connector type.
Credential Manager*	Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection. Supported Credential Managers: OE Credential Manager AWS Secrets Manager HashiCorp Azure Key Vault
License Add Ons	Auto Lineage Supported Data Quality Not Supported Data Access Not Supported Select the Auto Lineage Add-On checkbox to build data lineage automatically.
Connector Name*	Enter a unique name for the GitHub connection (Example: "GitHubdb").
Connector Environment	Select the environment (Example: PROD, STG) configured for the connector.
Connector Description	Enter a brief description of the connector.
GitHub Organization	Provide the name of the organization whose repositories the connector will access.
GitHub Owner	Provide the account or organization that owns the repository to be accessed.
Repo Name	Provide the exact name of the GitHub repository to be connected. It is used to identify and access the target repository for operations such as crawling, syncing, or data extraction.
Personal Access Token*	Provide a secure authentication token for accessing GitHub resources. It allows the connector to interact with repositories and perform operations based on the permissions granted to the token.
GitHub Path	Provide the repository or organization location to be accessed by the connector.
Proxy Enabled*	It specifies whether the GitHub connector should route requests through a proxy server. Select Yes to enable proxy usage, or No to bypass the proxy for direct connections.

Default Governance Roles

Default Governance Roles*	Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.

Admin Roles

Admin Roles*	Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection.

No of Archive Objects

No Of Archive Objects*	This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive. Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Bridge

Select Bridge*	If applicable, select the bridge from the drop-down list. The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.

1. After entering all connection details, the following actions can be performed:

   • Click Validate to verify the connection.

   • Click Save to store the connection for future use.

   • Click Save & Configure to apply additional settings before saving.

2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

To perform crawl operations, users must be assigned the Integration Admin role.

The Crawl/Profile button allows users to select one or more schemas for crawling.

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the schemas to crawl.

3. The Crawl option is selected by default.

4. Click Run to collect metadata from the connected source and load it into the Data Catalog.

5. After a successful crawl, the information appears in the Data Catalog > Databases/<>Codes tab.

The Schedule checkbox enables automated crawling at intervals ranging from a minute to a year.

1. Click the Schedule checkbox to enable the Select Period drop-down.

2. Select a time period for the operation from the drop-down menu.

3. Click Schedule to initiate metadata collection from the connected source.

4. The system will automatically execute the crawl operation at the scheduled time.

Other Operations

The Connectors page provides a centralized view of all configured connectors and their health status.

Managing connectors includes:

• Connector Health: Displays the current status of each connector, with a green icon for active connections and a red icon for inactive connections, helping monitor connectivity to data sources.

• Viewing: Click the Eye icon next to the connector name to view connector details, including FileFolders, Files, and File Columns.

Nine Dots Menu Options:

To view, edit, validate, build lineage, configure, or delete connectors, click on the Nine Dots menu.

• Edit Connector: Update and revalidate the data source.

• Validate Connector: Check the integrity of the connection.

• Settings: Modify connector settings.

  • Crawler: Configure data extraction.

  • Access Instructions: Add notes on how data can be accessed.

  • Business Glossary Settings: Manage term associations at the connector level.

• Build Lineage: Automatically build data lineage using source code parsing.

• Delete Connector: Remove a connector with confirmation.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S.No.	Error Message(s)	Error Description & Resolution
1	Error while validating GITHUBFILES connection Problem connecting to GitHub files server, please check Personal Access Token: Error while getting the API response: Please provide all required credentials to validate the GitHub files connection.	Error Description: Connection to the GitHub files server failed due to a missing or invalid Personal Access Token, preventing API response retrieval. Resolution: Ensure all required credentials, including a valid Personal Access Token, are provided and retry validating the GitHub files connection.

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.