Auto Onboard

For large teams with a lot of repositories, it’s a tedious process to manually configure .deepsource.toml file and activate DeepSource on all repositories, one by one. This is more so of a problem with our Enterprise customers. That's why we built Auto Onboard. Auto Onboard allows you to define your configuration blueprint, as templates, and then use it to activate analysis on multiple repositories in a single click.

Config Templates

Config templates can be created based on the programming languages or tech stack you use across your projects. For example, you can create a template for your webserver repositories, by adding Python and JavaScript analyzers. You can also add analyzers like Test Coverage and Secrets to keep track of the coverage results and to ensure that no secrets/keys are committed. We at DeepSource also use “Black” heavily for automated code formatting, so I’ll add a transformer for that as well.

Let’s go ahead and create a config template now,

  1. Go to Settings page from the dashboard (Note: Auto Onboard is not available for individual accounts at the moment).
  2. Under the “Auto Onboard” section, click “Add new template”.
  3. Give it a helpful name and description.
  4. Add all the analyzers and transformers as discussed above.

Your config might look something like this:


Activating DeepSource in multiple repositories

With templates in place, we can go ahead and “use” these templates to activate analysis on a batch of repositories.

  1. Click the "Activate new repository" button in the sidebar.
  2. Switch to “Use AutoOnboard” and select the template you want to use. Alternatively, you can also directly click the "Use this template" button from the template page (as shown in the screenshot above).
  3. Next, select all the repositories you want to onboard and click “Start onboarding”.

That’s it! DeepSource Bot will now create a pull request to each repository with a .deepsource.toml file. Analysis will be automatically activated for each repository as soon as the respective PR is merged by the repository's maintainer.