Connect GitHub with Bold Data Hub

The Bold Data Hub GitHub connector loads data on issues or pull requests from any GitHub repository into Bold Reports^® by using the GitHub API.

How do I get a GitHub access token?

You create the GitHub API token for Bold Data Hub as a personal access token in your GitHub developer settings.

Click your profile picture in the top right corner.
Choose Settings.
Select Developer settings from the left panel.
Under Personal access tokens, click Generate a personal access token (preferably under Tokens (classic)).
Check the following scopes to grant permissions to the token:
- public_repo: Limits access to public repositories.
- read:repo_hook: Grants read and ping access to hooks in public or private repositories.
- read:org: Read-only access to organization membership, organization projects, and team membership.
- read:user: Grants access to read a user’s profile data.
- read:project: Grants read-only access to user and organization projects.
- read:discussion: Allows read access for team discussions.
Click Generate token.
Copy the token and save it for future use.

Connection Properties

The GitHub connector in Bold Data Hub reads the following properties from the config section of a YAML file:

Connector name: GitHub
Access_token: Access token
Type: Reactions/repo_events
Owner: Owner
Repo: Repository Name
Items_per_page: Items per page
Max_items: Maximum number of items

Example Configuration

The following Bold Data Hub YAML templates show GitHub extractor configurations for repository events and for reactions.

Repo_events:

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: Github
      connectorname: Github
      config:
        access_token: <ACCESS TOKEN>
      properties:
        type: <REPO EVENTS>
        owner: <OWNER>

Reactions:

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: Github
      connectorname: Github
      config:
        access_token: <ACCESS TOKEN>
      properties:
        type: <REACTIONS>
        owner: <OWNER>
        repo: <REPO NAME>
        items_per_page: <ITEMS PER PAGE>
        max_items: <MAX NO OF ITEMS>
        max_items_age_seconds: <MAX ITEM AGE SECONDS>

How do I connect GitHub in Bold Data Hub?

You connect GitHub by creating a project in Bold Data Hub and adding the GitHub template to it.

Click the Bold Data Hub icon on the Navigation Pane.
Click Add Project and enter a name for the new project.
Select the newly created project and add the GitHub template.
Update the access token and repo in the template and save it to the Data Store.

Creating a pipeline in Bold Data Hub automatically creates a data source in Bold Reports^®. The Bold Reports^® data source is a live data source to the destination database used in Bold Data Hub.

FileSystem - DataHub

Warning:

1. The `Encrypt_Credentials` property should be set to false when updating the new access token on the template. If you have modified other properties, such as 'select' or 'account id', the `Encrypt_Credentials` property must be set to true.  
2. The default lifetime of the access token is 1 hour. Therefore, you need to convert it to a long-lived access token to use the same token for 60 days. Existing tables should be maintained even if the token has expired or is being used as an invalid token.

How do I schedule the GitHub pipeline?

You schedule the GitHub pipeline in Bold Data Hub from the schedules tab, or you run it on demand.

To configure interval-based scheduling, click the schedules tab, select the created pipeline, click the schedule icon, and configure the schedule.
For an on-demand refresh, click the Run Now button.
Check the schedule history with the history option and the logs.
Click Logs to see whether the run is completed and the data source is created in Bold Reports^®.
Click the Edit DataSource option to view the created tables.