Configure analysis

This guide assumes that you have already created an account on GitHub. If you haven't already, read here about how to sign up.

1. Once logged into your DeepSource account, go to the DeepSource dashboard (opens new window) and click "Activate new repo".

TIP

If you've got accounts from multiple providers (GitHub/GitLab) - or if you want to enable a repository owned by a GitHub organization or a GitLab group - choose the appropriate account from the drop down menu by clicking your username in the upper right corner.

Or, see this how-to adding more accounts to your DeepSource dashboard.

2. A list of all repositories for the selected account would appear on the screen. Use the search bar on the top to search for the repo you want to activate the analysis on and click on the repository name.

3. The repository onboarding wizard now appears on the screen which sets up the .deepsource.toml for you.

TIP

The analysis configuration for a repository on DeepSource is defined in a .deepsource.toml file in the repository's root. This file must be present at the said location for analysis to be run.

4. Fill in "Tests File Patterns" -- List of glob patterns of the test files. This helps us reduce false positives. For example:

5. Fill in "Excluded file patterns" -- List of glob patterns that should be excluded when the analyses are run. These patterns should be relative to the repository's root.

TIP

Files one would want to exclude from analysis, for example, are: generated binaries (bin/*), minified JS checked in repository, additional third party modules, etc:

6. Click "Add new" to see the list and add different analyzers. Click on the analyzer's name to add it, and fill in the required information.

7. Finally, just click on "Commit to GitHub" (or Bitbucket/GitLab), and the corresponding .deepsource.toml file will automatically be created and committed to your repo.

Your first analysis will be initialized right away. Give it a few minutes to munch on all the new code (The first analysis takes a few minutes depending on the size of the repository. The subsequent analysis would be much faster). It will automatically take you to the repo dashboard where you can browse through the results from deepsource.

DeepSource analysis is all set now. However, if you may want to further fine-tune the analysis, it's possible to change settings by passing along meta options in .deepsource.toml. A list of all such options for different analyzers can be found on the analyzers page.