Skip to Content

GitHub

GitHub connections give you access to your organization’s repository, pull request, and workflow data.

Source Setup

Etleap uses OAuth to authenticate with GitHub through the Etleap Connector GitHub App, which has read-only access to your organization.

Authorize the connection with a dedicated GitHub account that is an owner of your organization.

Step 1. Install the Etleap Connector App

  1. Sign in to GitHub as an owner of your organization and open the Etleap Connector  app page.

  2. Click Install and select your organization.

  3. Select All repositories, or select Only select repositories and choose the repositories that Etleap can read. Click Install.

Step 2. Create the Connection in Etleap

  1. Create a GitHub connection and click Authorize Access. The connection setup page will forward you to GitHub to authenticate and authorize Etleap to extract data on your behalf. Sign in with the dedicated account.

  2. Under GitHub Organization, enter the part after github.com/ in your organization’s URL. For example, enter acme for https://github.com/acme.

  3. Click Next. Enter a name for the connection, then click Create Connection.

Note

Prefer using an API? Go here  and select GitHub under the Body header to start creating a connection via API.

What Data is Available?

Warning

Update-Mode Deletes Support

Deletes are not supported for update-mode entities with this connector.

The diagram below shows the available entities and their relationships.

You can create GitHub pipelines with the following entities:

EntityPipeline ModeIceberg Support
Branch Protection ReplaceBatch
Branch Rules ReplaceBatch
Branches ReplaceBatch
Check Run Annotations Update-
Check Runs Update-
Code Owners ReplaceBatch
Code Scanning Alerts Update-
Collaborators ReplaceBatch
Commit Comments ReplaceBatch
Commit Statuses Update-
Commits Update-
Contributor Stats ReplaceBatch
Contributors ReplaceBatch
Copilot Seats ReplaceBatch
Dependabot Alerts Update-
Deployment Statuses Update-
Deployments Update-
Environments ReplaceBatch
Issue Comments Update-
Issue Events Update-
Issues Update-
Labels ReplaceBatch
Milestones ReplaceBatch
Organization ReplaceBatch
Organization Members ReplaceBatch
Outside Collaborators ReplaceBatch
Project Fields ReplaceBatch
Project Items ReplaceBatch
Projects ReplaceBatch
Pull Request Commits Update-
Pull Request Files Update-
Pull Request Review Comments Update-
Pull Request Reviews Update-
Pull Request Timeline Events Update-
Pull Requests Update-
Releases ReplaceBatch
Repositories ReplaceBatch
Repository Activity Update-
Repository Languages ReplaceBatch
Rule Suites Update-
Rulesets ReplaceBatch
Tags ReplaceBatch
Team Member History Update-
Team Members ReplaceBatch
Team Repositories ReplaceBatch
Teams ReplaceBatch
Traffic Clones Update-
Traffic Views Update-
Users Update-
Workflow Jobs Update-
Workflow Runs Update-
Workflows ReplaceBatch

Key Considerations

  • If you add a repository to the app installation later, refresh update-mode pipelines to reload their history with the new repository.
  • For each pull request, the current rows of Pull Request Commits, Pull Request Files, Pull Request Reviews, and Pull Request Timeline Events are the ones with the latest pull_request_updated_at.
  • Check Runs, Check Run Annotations, and Commit Statuses only contain results for the head commit of each pull request. Results that arrive more than 7 days after the pull request’s last update are not loaded.
  • Team Member History has a daily snapshot of each team’s members, starting on the day of the first extraction.
  • GitHub only returns the last 14 days of Traffic Views and Traffic Clones, the last month of Rule Suites, and the latest 30,000 Issue Events of each repository.