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 meltanolabs variant.

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

Using the Command Line Interface

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

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

Using Meltano UI

  1. Start Meltano UI using meltano ui:

    meltano ui
  2. Open the Extractors interface at http://localhost:5000/extractors.
  3. Click the “Add to project” button for “GitLab”.
  4. Choose "Add variant 'meltanolabs'".
  5. Configure the settings below in the “Configuration” interface that opens automatically.

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.

Settings

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

These and other supported settings 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 UI, 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 use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-gitlab set private_token <private_token>

export TAP_GITLAB_PRIVATE_TOKEN=<private_token>

Groups (groups)

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.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-gitlab set groups <groups>

export TAP_GITLAB_GROUPS=<groups>

Project (projects)

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.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-gitlab set projects <projects>

export TAP_GITLAB_PROJECTS=<projects>

ultimate_license

  • Environment variable: TAP_GITLAB_ULTIMATE_LICENSE, alias: GITLAB_API_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.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-gitlab set ultimate_license true

export TAP_GITLAB_ULTIMATE_LICENSE=true

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.

How to use

Manage this setting using Meltano UI, 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

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.

How to use

Manage this setting using Meltano UI, meltano config, or an environment variable:

meltano config tap-gitlab set fetch_pipelines_extended true

export TAP_GITLAB_FETCH_PIPELINES_EXTENDED=true

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 UI, 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!