Integrating GitHub with Sleuth is simple. If you're connecting to a personal GitHub repo, you just need your credentials. If you're part of a GitHub organization and aren't the owner, you will need permission to allow Sleuth to connect to the repo (after you connect you'll be able to select individual private or public repositories).

If you are using GitHub issues to track issues, Sleuth will automatically discover your referenced issues once the integration is configured. You can still use other issue tracker integrations if you don't use GitHub issues.

Check out the Sleuth app in the GitHub marketplace.

Setting up the integration

To set up the Sleuth GitHub integration:

  1. Click Add in the top navigation bar and select Integration from the list.

  2. Select Code from the drop-down located in the top right.

  3. In the GitHub tile, click Enable.

  4. Select the account with which you wish to authenticate your GitHub integration.

  5. Click Install & Authorize.

  6. Upon successful integration, you'll see GitHub marked as Enabled and a list of connections (you can have more than one) specified in the format Connected via GitHub App (account <GitHub user account> for ______________ repos.

Configuring the integration

After the initial setup is complete, the GitHub integration can be used to set up:

  • a code deployment: select a Sleuth project from the list and then follow the instructions for creating a code deployment

  • a build server: select a Sleuth project from the list to set GitHub as the Build integration provider for the selected project

  • an issue tracker: select a Sleuth project from the list to set GitHub as the Issue integration provider for the selected project

Adding more repositories

If you've selected Only select repositories during your initial setup and now want to give Sleuth access to more repositories, simply navigate to the Integrations page (click the Add button in the top nav and then click Integrations), click the arrow to expand the GitHub tile, and follow the Inspect link next to the connection you wish to update.

This will take you to GitHub installation's page where you can update your preferences.

In case of major changes to your GitHub organization

Making significant changes to your GitHub organization, such as renaming the organization, shouldn't have any effect on your existing GitHub-based code deployments and deploy data in Sleuth.

As per GitHub's official documentation, any attempt to access links containing the old organization name should get automatically redirected.

That being said, if you want to be extra sure, you can always disconnect your GitHub integration in Sleuth and re-connect it after the renaming, which will ensure Sleuth has the most up-to-date org info. You are also welcome to let our Support Team know of this change, so they can help ensure a smooth transition.

Removing the integration

If you wish to remove the GitHub integration for the organization:

  1. Click the Add button in the top nav and select Integrations from the list.

  2. Expand the GitHub integration card, and click Remove next to the connection you wish to remove. If you want to remove all of your GitHub connections, you'll need to repeat this step for each connection. A confirmation screen will appear warning you of the consequences of this action and prompting you to confirm your decision -> click Confirm.

After all connections are removed, the GitHub integration is then disconnected and no longer available for any projects within that organization.

Last updated