GitLab

Guide on integrating GitLab with Ketryx

1. Introduction

This section provides an introduction to the integration of GitLab with Ketryx. Our focus is on outlining the process of setting up this integration, utilizing Personal Access Tokens and Project Access Tokens, to enhance your software development practices. This guide will walk you through the steps required to establish a connection between GitLab and Ketryx.

1.2. Tools

Tools used to develop and release a product with Ketryx Lifecycle Management are provided in MAN-01 Ketryx Lifecycle Management. The release process is described in detail in MAN-02 Software Release Process, while setting up code repositories is described in MAN-03 Supply Chain Management.

Ketryx does not support Code Change Reviews with GitLab at this time. We are working on adding this feature in the future. Please reach out if you this feature is a priority for you.

2. Repository access

The integration process with GitLab varies slightly depending on whether you are working with public or private repositories. Here's a breakdown of the key differences:

2.1. Public Repositories

Accessibility: Public repositories are open to the public, meaning that anyone can view the repository content and its history.
Integration Setup: For public repositories, the setup process for integrating with Ketryx is generally straightforward. You do not need to use an access token for basic integration tasks, such as SOUP dependency analysis.

2.2. Private Repositories

Accessibility: Private repositories restrict access to authorized individuals or collaborators. Only those with permission can view and interact with the repository.
Integration Setup: When integrating with private repositories, you typically require an access token. This token ensures secure and authorized communication between GitLab and Ketryx for tasks like SOUP dependency analysis.

It's important to consider your repository's visibility when setting up the integration, as public and private repositories have distinct access requirements. The integration guide provides specific instructions based on the type of repository you are working with, ensuring a seamless and secure integration experience.

3. Access tokens

3.1. Creating a Personal Access Token for GitLab

Please see GitLab's documentation. The scope read_repository scope should be selected.

3.2. Creating a Project Access Token for GitLab

An alternative to the Personal Access Token is the Project Access Token. Steps on how to create one can be found in GitLab's documentation. For the scope, read_repository scope should be selected. For the role of the token, Reporter should be selected.

4.1. Using the Code Change Review feature with GitLab