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 the data source

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.

Before you start

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.

Configuring the data source

1. Enter your organization name.
2. Optionally, provide a personal access token to retrieve private repositories.

3. Optionally, select whether you would like to restrict access to this data source instance. By default, restricted access is set to off.

   Restrict access to this data source

   The term data source here really means data source instance. For example, a user may configure two instances of the AWS data source, one for their development environment and one for production. In that case, each data source instance has its own access control settings.

   By default, Restrict access to this data source is set to off. The data source can be viewed, edited and administered by anyone. If you would like to control who has access to this data source, switch Restrict access to this data source to on.

   Use the Restrict access to this data source dropdown to control who has access to the workspace:

   • By default, the user setting the permissions for the data source will be given Full Control and the Everyone group will be given Link to workspace permissions.
   • Tailor access to the data source, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.
   • If the user is not available from the dropdown, you are able to invite them to the data source by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp. Once the account has been created, they will gain access to the organization.
   • At least one user or group must be given Full Control.
   • Admin users can edit the configuration, modify the Access Control List (ACL) and delete the data source, regardless of the ACL chosen.

   Data source access levels

   Access Level:

   Link to workspace	User can link the data source to any workspace they have at least Editor permissions for. Data from the data source can then be viewed by anyone with any access to the workspace. User can share the data source data with anyone they want. User cannot configure the data source in any way, or delete it.
   Full Control	User can change the data source configuration, ACL, and delete the data source.

   See Access control for more information.

4. 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.