GitLab

The GitLab integration is available upon request. Contact support@sleuth.io if you are interested.

About the integration

Code deployments are one of the key sources of change Sleuth needs to do its job. Once a code deployment is integrated as a change of source, Sleuth immediately begins its analysis, looking at your commit history, number of authors, deploy frequency, size of commits, and other data to give you a full picture of how you and your team are managing your project's codebase. You'll instantly see the Trend Graph come to life with a complete snapshot that gives you the information you need to start deploying faster.

Integrating GitLab with Sleuth is simple. If you're setting connecting to a personal GitLab repo, you just need your credentials. If you're part of an 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).

You can connect as many repositories to a project as you'd like; be sure to name them accordingly in Sleuth. You will also be able to tell Sleuth whether it should manually register each deploy or automatically create deploys for every push to or tag on branch; it's completely up to you. This setting can be changed at any time. Additionally, you can configure your target branch to lock if it contains unreleased code.

Check out the Bitbucket, GitHub, Jira, or Clubhouse integration pages if you'd like to track your issues using those tools instead of or in addition to GitLab.

Setting up the integration

To set up the Sleuth GitLab integration:

  1. Click Integrations in the left sidebar, then click Change Sources.

  2. In the GitLab tile, click enable.

  3. You must grant Sleuth access to your GitLab account. Don't worry, you'll select the GitLab repo to connect to your Sleuth project later.

  4. On successful integration, you'll see GitLab is connected as {Bitbucket user account} displayed in the GitLab tile, and the GitLab logo will turn green. You'll next configure the code deployment to connect your repo to a project.

Configuring the integration

You now need to add a GitLab repo to a Sleuth project. This source of change is the repo the configured Sleuth project will monitor and report in the Dashboard on each and every deploy you make to that repo, along with any other change sources you have connected to your project.

To configure the GitLab integration:

  1. After step #4 above, you will be taken back to the GitLab integration tile. On the GitLab tile, click the Add code deployment dropdown.

  2. Select the Sleuth project you wish to add a chance source to from the dropdown list.

  3. In the Add a new Code Deployment change source screen, you must configure which code repo and branch to monitor; give the code deployment a name; select the deploy tracking type; and tell Sleuth whether to lock the target branch if it has unreleased code.

Removing the integration

If you wish to dissolve the GitLab integration for the organization:

  1. Click on Integrations in the left sidebar, then on Change Sources.

  2. In the GitLab integration card, click disable.

The GitLab integration is disconnected and no longer available to any projects within that organization.