Skip to content

How to Connect Teamscale's Requirements Tracing to GitLab

Teamscale integrates with the GitLab Issue Tracker via the GitLab REST API. This is used to connect GitLab Issues as Specification Items for requirements tracing purposes. The guide for connecting the code on GitLab can be found here.

General Option Reference

This guide only covers the options specific to the GitLab Issues as Requirement Management Tool. A general overview of connector options is available here.

Prerequisites for the GitLab integration

Prerequisites for the configuration are:

  • Teamscale installation that can reach the GitLab instance you want to connect to.
  • A GitLab Access Token with the read_api scope that can access the GitLab project.

Setup of the GitLab Connector

  1. In Teamscale, go Project Configuration > Projects and edit or create a project. Click on the Requirements Management Tool button and choose GitLab Issues as Requirement Management Tool.

    Screenshot of the selected GitLab Requirements Management Tool

  2. Fill out the following fields in the connector settings:

    • Account: Choose an existing account, or create one using the GitLab root URL (e.g. https://gitlab.com) and the previously created access token.
    • Project: The global (numeric) project ID, or the complete path (<namespace>/<projectPath>) of the GitLab project.
    • Labels: Comma-separated list of labels. Only issues with any of these labels are imported. Leave empty to import all issues.
  3. Click Save Project and wait for the finished reanalysis.

  4. The Specification Items can be found under Requirements Tracing.