The tap-gitlab Meltano extractor pulls data from GitLab that can then be sent to a destination using a loader.

Alternative variants #

Multiple variants of tap-gitlab are available. This document describes the default meltanolabs variant, which is recommended for new users.

Alternative variants are:

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the tap-gitlab extractor to your project using meltano add : 

    meltano add extractor tap-gitlab
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Select entities and attributes to extract
  2. Add a loader to send data to a destination
  3. Run a data integration (EL) pipeline
If you run into any issues, learn how to get help.

Capabilities #

Settings #

tap-gitlab requires the configuration of one of the following groups of settings:

The settings for extractor tap-gitlab that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

GitLab Instance (api_url) #

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

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set api_url <api_url>

export TAP_GITLAB_API_URL=<api_url>

Access Token (private_token) #

GitLab personal access token or other API token.

How to get #

The process for getting the private token or personal access token is very simple:

  1. Navigate to your profile’s access tokens.

  2. Fill out the personal access token form with the following properties:

  • Name: meltano-gitlab-tutorial
  • Expires: leave blank unless you have a specific reason to expire the token
  • Scopes:
    • api

  1. Click on Create personal access token to submit your request.

  2. You should see your token appear at the top of your screen. It should look something like this: I8vxHsiVAaDnAX3hA

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set private_token <private_token>

export TAP_GITLAB_PRIVATE_TOKEN=<private_token>

Groups (groups) #

This property allows you to scope data that the extractor fetches to only the desired group. The group name can generally be found at the root of a repository’s URL. If this is left blank, you have to at least provide a project.

Leave empty if you’d like to pull data from a project in a personal user namespace.

For example, https://github.com/MeltanoLabs/tap-gitlab has a group of meltano.

Multiple group names can be separated using space characters.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set groups <groups>

export TAP_GITLAB_GROUPS=<groups>

Project (projects) #

This property allows you to scope the project(s) that the extractor fetches.

Leave empty if you’ve specified one or more groups and would like to pull data from all projects inside these groups.

The format for it is namespace/project, where namespace can be a username or group name. Here are a couple examples:

Multiple group paths can be separated using space characters.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set projects <projects>

export TAP_GITLAB_PROJECTS=<projects>

Ultimate License (ultimate_license) #

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

The epics and epic_issues entities cannot be selected unless this setting is enabled.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set ultimate_license true

export TAP_GITLAB_ULTIMATE_LICENSE=true

Fetch Merge Request Commits (fetch_merge_request_commits) #

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.

The merge_request_commits entity cannot be selected unless this setting is enabled.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set fetch_merge_request_commits true

export TAP_GITLAB_FETCH_MERGE_REQUEST_COMMITS=true

Fetch Pipelines Extended (fetch_pipelines_extended) #

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.

The pipelines_extended entity cannot be selected unless this setting is enabled.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set fetch_pipelines_extended true

export TAP_GITLAB_FETCH_PIPELINES_EXTENDED=true

Start Date (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.

How to use #

Manage this setting using meltano config or an environment variable: 

meltano config tap-gitlab set start_date YYYY-MM-DDTHH:MM:SSZ

export TAP_GITLAB_START_DATE=YYYY-MM-DDTHH:MM:SSZ

Looking for help? #

If you're having trouble getting the tap-gitlab extractor to work, 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. Edit it on GitHub!