Connect GitLab (Source Control and CICD Pipeline)

Summary

Connecting GitLab source control and CICD pipeline data sources

In order to get Lead Time, Deployment Frequency and Change Failure Rate metrics, you need to add source control and CICD pipeline data sources for your product in WayFinder. Connecting your GitLab project data can provide this data.

There is only one item you will need:

  • GitLab personal access token

GitLab Personal Access Token (PAT)

Least Privilege and Least Data

We aim to ingest only the minimum data possible to provide you with metrics. For GitLab you remain in control of this by providing WayFinder with a GitLab PAT with limited scopes.

Creating a PAT

Follow the instructions from GitLab to create-a-personal-access-token.

This PAT can be used for connecting both Source Control and CICD Pipeline data sources to WayFinder. If you have previously created a GitLab PAT for WayFinder you can skip this section and reuse the token you previously created. If you no longer have a copy of that token, just create a new one but do not delete or regenerate the previous token or the other data source will stop working.

What permissions are needed?

We aim to use least privilege and therefore only the following scope is needed to be added to the PAT:

  • read_api

Products in WayFinder

In WayFinder we have a grouping called a “Product”. When organisations are developing a product or service there are typically multiple repositories and multiple CICD pipelines.

For example there may be a frontend repository and a backend repository and each may have it’s own CICD pipeline for deployment. The metrics for the "Product" are aggregated to include all the associated repositories and their CICD pipelines.

Public Repositories in GitLab

Please note that WayFinder ignores public repositories in you GitLab account, if you need a public repository included in your project please contact us at contact@wayfinder.ninja