Documentation

Description

GitHub is the world's leading software development platform, providing code hosting, version control, collaboration tools, and project management features for developers and teams.

Follow our setup guide to connect GitHub to Improvado.

Step 1. Click the Make a new Connection on the Connections page.
Categories on the Data sources page group all available platforms. Use a search to find the required one.

Step 2. Click on the GitHub tile.

Step 3. Authorize your GitHub account by filling in the authorization form:

Note: You can generate a Personal Access Token by following these steps:

Step 3.1. Go to GitHub Settings.

Step 3.2. Navigate to Developer settings and then Personal access tokens.

Step 3.3. Click Generate new token and select the required scopes: read:org (to discover organizations and members) and repo (to read commits and repository data).

Step 3.4. Click Generate token and copy the token value.

Step 3.5. Enter the copied token into the Improvado authorization form.

{%docs-informer info%}

If you are using GitHub Enterprise Server, make sure to also enter the GitHub API URL field with your instance's API endpoint (e.g., https://github.yourcompany.com/api/v3).

{%docs-informer-end%}

For more details, refer to the official GitHub documentation on Personal Access Tokens.

Step 4. After completing the connection process, the GitHub connection will appear in your Connected sources list.

Step 5. When the connection status is Active, and the account status column shows a number of accounts, you can move on to data extraction.

Step 6. To extract data from the connected sources, check the instructions on how to set up data extraction.

The schema information shows all report types you can use to extract data from GitHub.