GitHub

The following guide describes how to integrate Garnet with your GitHub repositories for monitoring.

Garnet integrates natively with GitHub through a GitHub app that you can install on your personal GitHub repositories and on the repositories of your GitHub organizations.

Note: the Garnet GitHub app only has read access to your code. You will need Owner or Manager rights in Garnet to set up an integration or customize your settings.

You can refer to the GitHub documentation for more information on GitHub apps.

You can install Garnet on your personal GitHub account to monitor your personal repositories.

To install Garnet on a GitHub organization you need to be an administrator of that GitHub organization.

Note: if you try to install Garnet on a GitHub organization for which you are not an administrator (but only a member), the integration will fail, and will therefore not be linked to your Garnet workspace.

You will first need to create a GitHub integration in your Garnet workspace.

  1. Navigate to Integrations > New

  2. Enter your GitHub username and select 'GitHub' as type from the dropdown menu

  3. Click on Connect to start the GitHub app installation process (you will then be redirected to GitHub).

  4. Authenticate on GitHub if you are not already logged in.

  5. Choose where to install the GitHub app (either for your personal GitHub account or for the GitHub organization of which you are an admin)

  6. Select the repositories you want to be monitored through Garnet

Note: allowing all repositories will enable Garnet's monitoring on all your code. This is a good practice, as it's hard to predict where exactly the leaks will happen.