GitHub plugin

For more information about what this plugin does and the data streams it retrieves, see:

GitHub

Monitor the Incidents, Issues and Pull Requests from your GitHub environment.

This data source indexes an organization and repositories for a given organization name. You can also retrieve private repositories if you add a personal access token (optional).

How to add a GitHub data source

Generate a Personal Access Token

In order to add a GitHub data source in SquaredUp, you need to provide a personal access token, generated in GitHub.

GitHub offers both 'Fine-grained' tokens and 'Classic' tokens. A 'Fine-grained' token should be used because this allows minimal read-only access to the required data.

To generate a fine-grained personal access token:

  1. In GitHub, navigate to Settings > Developer settings > Personal access tokens > Fine-grained tokens.
  2. Click Generate new token.
  3. Provide a Token name, Expiration date and description for the token.
  4. Set the Resource owner to an organisation if you need to access private repositories owned by an organisation. If you use a personal access token in SquaredUp with a user set as the resource owner, SquaredUp will only be able to access private repositories owned by that user.

    You may need to first allow access via fine-grained personal access tokens for your organization before you can set it as the resource owner.

  5. Select Public, All or Only Select repositories from Repository Access, depending on your needs.
  6. Grant Read-only access for the appropriate Account permissions. Currently, the plugin requires the following minimum permissions to function:
    1. Issues
    2. Metadata
    3. Pull requests
  7. Click 'Generate token'
  8. Copy the token before closing the page.

    You may need an admin to approve the token before it can gain full access to repositories, depending on your organization's security policy.

Add a data source to SquaredUp

  1. To add a data source click on the + next to Data Sources on the left-hand menu in SquaredUp. Search for the data source and click on it to open the Configure data source page.

  2. Enter your organization name.
  3. Optionally, provide a personal access token to retrieve private repositories.
  4. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

  5. Click Add.

    You can also add a data source from Settings > Data Sources > Add data source, but sample dashboards are not added when using this method.

Was this article helpful?


Have more questions or facing an issue?