GitHub plugin

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

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

Adding a 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.

To access an organization's private repositories, you must provide a personal access token when configuring the data source. This token must be generated in GitHub for an account that has access rights to the private repositories you want to access.

GitHub offers both "Fine-grained" tokens and "Classic" versions of its access tokens. It's highly recommended to generate a "Fine-grained" token as because this allows you to grant minimal read-only access to the required data.

Generating a Personal Access Token

In GitHub, navigate to Settings > Developer settings > Personal access tokens > Fine-grained tokens.
Click Generate new token.
Complete the following fields:
1. Token name:
  Enter a name for the token. For example, SquaredUp Plugin.
2. Description:
  Optionally, enter a description for the token.
3. Resource owner:
  Select the organization that you want to access the private repositories of.
  If you configure a personal access and select a user 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.
4. Expiration:
  Select an expiration data for the token. Once the token expired it must be regenerated and updated in SquaredUp.
5. Repository access:
  Select All repositories to enable access to private repositories.
6. Permissions:
  Grant Read-only access as required for the Repository permissions and Organizationpermissions. Currently, the plugin requires the following minimum Repository permissions to function:
  - Issues
  - Metadata
  - Pull requests
Click Generate token. When prompted to review the selected permissions, click Generate token again.
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

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

(Optional) Restrict access to this data source:
You can enable this option if you only want certain users or groups to have access to the data source, or the permission to link it to new workspaces. See data source access control for more information.

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.

Access level	Permissions
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.

Click Test and add to validate the data source configuration. SquaredUp will now attempt to connect to SquaredUp using the provided authentication method.
- Testing passed – a success message will be displayed and then the configuration will be saved.
- Testing passed with warnings – warnings will be listed and potential fixes suggested. You can still use the data source with warnings. Select Save with warnings if you believe that you can still use the data source as required with the warnings listed. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
- Testing Failed – errors will be listed and potential fixes suggested. You cannot use the data source with errors. You are able to select Save with errors if you believe that a system outside of SquaredUp is causing the error that you need to fix. Alternatively, address the issues listed and then select Rerun tests to validate the data source configuration again. If the validation now passes, click Save.
You can edit any data source configurations at any time from Settings > Data Sources.

Next steps

Data streams

You can use these data streams to create new tiles to show data, or if there are preconfigured dashboards installed you can copy or edit those.

Data streams standardize data from all the different shapes and formats your tools use into a straightforward tabular format.

While creating a tile you can tweak data streams by grouping or aggregating specific columns.

Depending on the kind of data, SquaredUp will automatically suggest how to visualize the result, for example as a table or line graph.

Data streams can be either global or scoped:

Global data streams are unscoped and return information of a general nature (e.g. "Get the current number of unused hosts").
A scoped data stream gets information relevant to the specific set objects supplied in the tile scope (e.g. "Get the current session count for these hosts").

See Data Streams for more information.

The following data streams are installed with this plugin.

Data stream	Description
Dependabot Alerts	Returns Dependabot alerts for the selected repositories.
Issues (Org) / Closed	Returns the 100 most recently closed issues.
Issues (Org) / Created	Returns the 100 most recently created issues of any state.
Issues (Org) / Open (Anytime)	Returns the 100 most recently updated open issues.
Issues (Repo) / Closed	Returns the 100 most recently closed issues.
Issues (Repo) / Created	Returns the 100 most recently created pull requests of any state.
Pull Requests / Closed	Returns the 100 most recently closed pull requests.
Pull Requests / Created	Returns the 100 most recently created pull requests of any state.
Pull Requests / Open (Anytime)	Returns the 100 most recently updated open pull requests.
Releases	Returns a list of releases for the selected repositories.
Repos	Returns a list of all repositories for the organization in scope.
Status	Returns a summary of the status page.
User Information	Returns a list of users and information about each team corresponding to them.

Configurable data streams

The following installed data streams have configurable Parameters.

Data stream	Description	Parameters
Code Scanning	Returns code scan alerts for selected repositories.	State: Specify a state to filter alerts by. Severity: Specify a severity to filter alters by.
Incidents	Return GitHub incidents filtered by their Status.	Status: Specify a resolved status to filter incidents by.
In Progress Workflows	Retrieves your in-progress job processes and the information relating to them such as the Name, the job Trigger, the start time and end time etc. Configured as a preset of the `Workflow Runs` data stream.	Workflow Name: Specify the name of a specific workflow to return. Status: Specify a workflow status to filter by. Actor: Specify the person or entity that triggered a workflow to filter by. Branch: Specify a branch to filter by. Event: Specify a workflow trigger event to filter by.
Search Issues	Search issues and pull requests by specifying search a GitHub search query.	Search Issue Query: Enter a GitHub search query to fetch issues for.
Secret Scanning	Returns alerts for secret scans for selected repositories.	State: Specify a state to filter secrets by. Validity: Specify a validity to filter secrets by.
Workflow Runs	Fetches your automated job processes and the information relating to them such as the Name, the job Trigger, the start time and end time etc.	Workflow Name: Specify the name of a specific workflow to return. Status: Specify a workflow status to filter by. Actor: Specify the person or entity that triggered a workflow to filter by. Branch: Specify a branch to filter by. Event: Specify a workflow trigger event to filter by.

Was this article helpful?

Have more questions or facing an issue?

Submit a ticket