Integrating DeepSource with your Github account is done using a Github application.
This document outlines the configuration, permission requirements and app configuration to get started with your Github account and DeepSource Enterprise.
To create the app, you can run this quick setup script with a few additional steps. This script will open up a website with the Github app creation page and fill in the required fields automatically.
If you get a 404 page when the quick setup script is run, ensure that you’re logged in and that you have the permission to create apps — Admin access — for the respective organization.
When you run the command in the CLI, a few user details will have to be filled in:
The script will open a new browser page. Complete the following steps:
Permissions
section and select Read-only
for Email addresses
and Git SSH Key
.Click on Create GitHub App.
This will take you to the About page for your Github application. Scroll down the page to the Private keys section and press Generate a private key. Keep this key safely since you will need to upload this in the Admin Console in the next section.
Note down the following values:
APP_SLUG
part of the URL on the Github app page. https://github.com/organizations/acme_corp/settings/apps/<APP_SLUG>
You will use these values to configure the Github App in the Admin Console. Follow the next steps to continue.
Click on Save config
and deploy. (Ensure that you have completed the steps in the Adming Console page before you deploy.)
Visit the login page on https://<DEEPSOURCE_HOSTNAME>/login
to start using Github with DeepSource Enterprise.
After you create your Github application, you need to configure these in the Admin Console for the application to use it.
Visit the Admin Console
Navigate to Application -> Config.
Select the checkbox Github
Fill up the values from the previous step for:
Save
Permission | Scope | Reason |
---|---|---|
Checks | Read and write | Update pull request checks when an analysis is run. |
Commit statuses | Read and write | For updaing commit statuses in the PR. |
Contents | Read and write | Get source code during analysis. |
Metadata | Read-only | The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. |
Pull requests | Read and write | Create pull requests for autofix. |
Single file | Read and write | Read and write the .deepsource.toml |
Webhooks | Read-only | Receive webhook notifications when the source code changes. |
Email address | Read-only | To authenticate your user account. |
Git SSH Key | Read-only | For cloning private repositories. |
Integrating DeepSource with your Github account is done using a Github application.
This document outlines the configuration, permission requirements and app configuration to get started with your Github account and DeepSource Enterprise.
To create the app, you can run this quick setup script with a few additional steps. This script will open up a website with the Github app creation page and fill in the required fields automatically.
If you get a 404 page when the quick setup script is run, ensure that you’re logged in and that you have the permission to create apps — Admin access — for the respective organization.
When you run the command in the CLI, a few user details will have to be filled in:
The script will open a new browser page. Complete the following steps:
Permissions
section and select Read-only
for Email addresses
and Git SSH Key
.Click on Create GitHub App.
This will take you to the About page for your Github application. Scroll down the page to the Private keys section and press Generate a private key. Keep this key safely since you will need to upload this in the Admin Console in the next section.
Note down the following values:
APP_SLUG
part of the URL on the Github app page. https://github.com/organizations/acme_corp/settings/apps/<APP_SLUG>
You will use these values to configure the Github App in the Admin Console. Follow the next steps to continue.
Click on Save config
and deploy. (Ensure that you have completed the steps in the Adming Console page before you deploy.)
Visit the login page on https://<DEEPSOURCE_HOSTNAME>/login
to start using Github with DeepSource Enterprise.
After you create your Github application, you need to configure these in the Admin Console for the application to use it.
Visit the Admin Console
Navigate to Application -> Config.
Select the checkbox Github
Fill up the values from the previous step for:
Save
Permission | Scope | Reason |
---|---|---|
Checks | Read and write | Update pull request checks when an analysis is run. |
Commit statuses | Read and write | For updaing commit statuses in the PR. |
Contents | Read and write | Get source code during analysis. |
Metadata | Read-only | The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. |
Pull requests | Read and write | Create pull requests for autofix. |
Single file | Read and write | Read and write the .deepsource.toml |
Webhooks | Read-only | Receive webhook notifications when the source code changes. |
Email address | Read-only | To authenticate your user account. |
Git SSH Key | Read-only | For cloning private repositories. |