GitHub collector

[ 1 Service description ] [ 2 Data source description ] [ 3 Setup ] [ 4 Run the collector ]

Service description

GitHub is a web-based platform used for version control. Git simplifies the process of working with other people and makes it easy to collaborate on projects. Team members can work on files and easily merge their changes with the master branch of the project.

Data source description

The GitHub API provides all the information about a code repository hosted with them, from commits to pull requests and comments.

Listed below are the resources that can be sent to Devo:

Service	Resource	Description	Devo tables

Service	Resource	Description	Devo tables
Repository	Collaborators	Information about the repository collaborators	`vcs.github.repository.collaborators`
Repository	Commits	Commits made in the repository	`vcs.github.repository.commits`
Repository	Forks	Forks created in the repository	`vcs.github.repository.forks`
Repository	Events	Information about the different events, such as resource creations or deletions	`vcs.github.repository.events`
Repository	Issue comments	Comments made in every issue	`vcs.github.repository.issue_comments`
Repository	Subscribers	Information about the different users subscribed to one repository	`vcs.github.repository.subscribers`
Repository	Pull requests	Pull requests made in the repository	`vcs.github.repository.pull_requests`
Repository	Subscriptions	Repositories you are subscribed	`vcs.github.repository.subscriptions`
Repository	Releases	Information about releases made in the repository	`vcs.github.repository.releases`
Repository	Stargazers	Information about the users who “starts” repositories making them favorites	`vcs.github.repository.stargazers`
Organization	Audit	Organization auditory events	`vcs.github.organization.audit`
Organization	SSO Authorizations	Single sign-on authorization	`vcs.github.organization.sso_authorizations`
Organization	Webhooks	Organization created webhooks	`vcs.github.organization.webhooks`

Learn more about the vcs.github data tables here.

Setup

Getting the required credentials

Log in to your GitHub account. This account needs to be the main or principal account that controls all GitHub.
Go to Settings → Developer settings → Personal access tokens and click Generate new token.
Check the following options and click Generate token.

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).