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:
Information about the repository collaborators
Commits made in the repository
Forks created in the repository
Information about the different events, such as resource creations or deletions
Comments made in every issue
Information about the different users subscribed to one repository
Pull requests made in the repository
Repositories you are subscribed
Information about releases made in the repository
Information about the users who “starts” repositories making them favorites
Organization auditory events
Single sign-on authorization
Organization created webhooks
Learn more about the vcs.github data tables here.
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).
We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, get in touch with us and we will guide you through the configuration.
This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
The following directory structure should be created for being used when running the GitHub collector:
In Devo, go to Administration → Credentials → X.509 Certificates, download the Certificate, Private key and Chain CA and save them in
Editing the config-github.yaml file
In the config-github.yaml file, replace the
Download the Docker image
The collector should be deployed as a Docker container. Click here to download the Docker image of the collector as a .tgz file.
Use the following command to add the Docker image to the system:
Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace "
The Docker image can be deployed on the following services:
Execute the following command on the root directory
The following Docker Compose file can be used to execute the Docker container. It must be created in the
To run the container using docker-compose, execute the following command from the