The tap-gitlab Singer tap pulls data from GitLab that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-gitlab are available. This document describes the meltano variant.

Alternative variants are:

Standalone usage #

Install the package using pip: 

pip install git+https://gitlab.com/meltano/tap-gitlab.git

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Install Meltano, create your Meltano project, and add the tap to your project as an extractor: 

meltano add extractor tap-gitlab --variant meltano

For additional instructions, refer to the Meltano-specific documentation for tap-gitlab.

Capabilities #

Settings #

GitLab Instance (api_url) #

  • Default: https://gitlab.com

GitLab API/instance URL. When an API path is omitted, /api/v4/ is assumed.

Access Token (private_token) #

  • Default:

GitLab personal access token or other API token.

Groups (groups) #

  • Default:

Space-separated names of groups to extract data from. Leave empty and provide a project name if you’d like to pull data from a project in a personal user namespace.

Project (projects) #

  • Default:

Space-separated namespace/project paths of projects to extract data from. Leave empty and provide a group name to extract data from all group projects.

ultimate_license #

  • Default: false

Enable to pull in extra data (like Epics, Epic Issues and other entities) only available to GitLab Ultimate and GitLab.com Gold accounts.

fetch_merge_request_commits #

  • Default: false

For each Merge Request, also fetch the MR’s commits and create the join table merge_request_commits with the Merge Request and related Commit IDs. This can slow down extraction considerably because of the many API calls required.

fetch_pipelines_extended #

  • Default: false

For every Pipeline, also fetch extended details of each of these pipelines. This can slow down extraction considerably because of the many API calls required.

start_date #

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Looking for help? #

If you're having trouble getting tap-gitlab to work by itself or with Meltano, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to! It is also validated against a JSON Schema used for taps and targets.


Edit this page on GitLab!