Skip to main content
Version: Next

@backstage/plugin-catalog-backend-module-gitlab

Home > @backstage/plugin-catalog-backend-module-gitlab

A Backstage catalog backend module that helps integrate towards GitLab

Classes

Class

Description

GitlabDiscoveryEntityProvider

Discovers catalog files located in your GitLab instance. The provider will search your GitLab instance's projects and register catalog files matching the configured path as Location entity and via following processing steps add all contained catalog entities. This can be useful as an alternative to static locations or manually adding things to the catalog.

GitLabDiscoveryProcessor

Extracts repositories out of an GitLab instance.

GitlabOrgDiscoveryEntityProvider

Discovers users and groups from a Gitlab instance.

Interfaces

Interface

Description

GroupNameTransformerOptions

The GroupTransformerOptions

GroupTransformerOptions

The GroupTransformer options

UserTransformerOptions

The UserTransformerOptions

Variables

Variable

Description

catalogModuleGitlabDiscoveryEntityProvider

Registers the GitlabDiscoveryEntityProvider with the catalog processing extension point.

Type Aliases

Type Alias

Description

GitLabGroup

Representation of a GitLab group in the GitLab API

GitLabGroupSamlIdentity

GitlabProviderConfig

The configuration parameters for the GitlabProvider

GitLabUser

Representation of a GitLab user in the GitLab API

GroupNameTransformer

Customize how group names are generated

GroupTransformer

Customize the ingested Group entity

UserTransformer

Customize the ingested User entity