Skip to main content Skip to complementary content

GitHub 

GitHub is a platform and cloud-based service for software development and version control using Git. You can use GitHub as a data source when landing or replicating data.

GitHub integration replicates data using the GitHub REST API v3.

See the Schema section for a list of objects available for replication.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Information noteMake sure that the account you use has read access to the tables you want to fetch.

Creating the connection

For more information, see Connecting to SaaS applications.

  1. Fill in the required connection properties.
  2. Provide a name for the connection in Connection name.

  3. Select Open connection metadata to define metadata for the connection when it has been created.

  4. Click Create.

Connection settings
SettingDescription
Data gateway

Select a Data Movement gateway if required by your use case.

Information note

This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None.

For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.

Start Date

Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.

Github Repository NameGithub Repository Name
Access token

Access token.

Schema

Information note

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 2.

Depending on your destination, table and column names may not appear as they are outlined below.

assignees

The assignees table contains info about the available assignees for issues in the repositories specified for the integration.

Replication Method

Full Table

Primary Key

id

Useful links

GitHub documentation

GitHub API method

collaborators

The collaborators table contains info about the users who contribute to the repositories specified for the integration.

For organization-owned repositories, this will include outside collaborators, organization owners, organization members that are direct collaborators, who have access through team memberships, or have access through default organization permissions.

Replication Method

Full Table

Primary Key

id

Useful links

GitHub API method

comments

The comments table contains info about comments made on issues in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub documentation

GitHub API method

commit_comments

The commit_comments table contains info about the commit comments in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Replication Key

updated_at

Useful links

GitHub API method

commits

The commits table contains info about repository commits in a project.

Replication Method

CDC

Primary Key

sha

Useful links

GitHub documentation

GitHub API method

events

The events table contains information about events in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub documentation

GitHub API method

issue_events

The issue_events table contains info about issue events in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub API method

issue_labels

The issue_labels table contains info about issue labels in the repositories specified for the integration.

Replication Method

Full Table

Primary Key

id

Useful links

GitHub API method

issue_milestones

The issue_milestones table contains info about issue milestones in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub API method

issues

The issues table contains info about issues in the repositories specified for the integration.

Issues and pull requests

GitHub’s API considers every pull request an issue, but not every issue may be a pull request. Therefore, this table may contain both issues and pull requests.

Replication Method

CDC

Primary Key

id

Useful links

GitHub documentation

GitHub API method

pr_commits

The pr_commits table contains info about pull request commits and is a slight variation of the commits table. This allows you to associate commits to pull requests that are squash merged.

Replication Method

CDC

Primary Key

id

Useful links

pr_commits schema on GitHub

GitHub API method

project_cards

The project_cards table contains information about project cards in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub documentation

GitHub API method

project_columns

The project_columns table contains info about the columns of projects in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub API method

projects

The projects table contains info about projects in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub API method

pull_requests

The pull_requests table contains info about pull requests made against the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub documentation

GitHub API method

releases

The releases table contains info about releases in the repositories specified for the integration.

Note: GitHub doesn’t include regular Git tags that haven’t been associated with a release.

Replication Method

Full Table

Primary Key

id

Useful links

GitHub API method

review_comments

The review_comments table contains info about comments made on pull request reviews in the repositories specified for the integration.

Replication Method

CDC

Primary Key

id

Useful links

GitHub API method

reviews

The reviews table contains info about pull request reviews in the repositories specified for the integration. A pull request review is a group of comments on a pull request.

Replication Method

CDC

Primary Key

id

Useful links

GitHub documentation

GitHub API method

stargazers

The stargazers table contains info about users who have starred the repositories specified for the integration.

Replication Method

Full Table

Primary Key

user_id

Useful links

GitHub API method

team_members

The team_members table contains info about members of organization teams that are visible to the user who authorized the integration.

Replication Method

Full Table

Primary Key

id

Useful links

GitHub API method

team_memberships

The team_memberships table contains info about membership of users in of organization teams that are visible to the user who authorized the integration.

Replication Method

Full Table

Primary Key

url

Useful links

GitHub API method

teams

The teams table contains info about the teams in an organization. Only teams that are visible to the user who authorized the integration in Stitch will be replicated.

Replication Method

Full Table

Primary Key

id

Useful links

GitHub API method

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!