Meltano

# GitLab

The tap-gitlab extractor pulls data from the GitLab API.

To learn more about tap-gitlab, refer to the repository at https://gitlab.com/meltano/tap-gitlab.

# 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

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

# Settings

tap-gitlab requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents in the sidebar.

# Minimal configuration

A minimal configuration of tap-gitlab in your meltano.yml project file will look like this:






 
 
 

plugins:
  extractors:
  - name: tap-gitlab
    variant: meltano
    pip_url: git+https://gitlab.com/meltano/tap-gitlab.git
    config:
      projects: meltano/meltano meltano/tap-gitlab
      start_date: '2020-10-01T00:00:00Z'

Sensitive values are most appropriately stored in the environment or your project's .env file:

export TAP_GITLAB_PRIVATE_TOKEN=my_private_token

# 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 https://gitlab.example.com

export TAP_GITLAB_API_URL=https://gitlab.example.com

# 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 UI, meltano config, or an environment variable:

meltano config tap-gitlab set private_token <token>

export TAP_GITLAB_PRIVATE_TOKEN=<token>

# 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://www.gitlab.com/meltano/tap-gitlab has a group of meltano.

Multiple group names can be separated using space characters.

# How to use

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

meltano config tap-gitlab set groups "<group1> <group2>"

export TAP_GITLAB_GROUPS="<group1> <group2>"

# For example:
meltano config tap-gitlab set groups meltano
meltano config tap-gitlab set groups "meltano gitlab"

export TAP_GITLAB_GROUPS=meltano
export TAP_GITLAB_GROUPS="meltano gitlab"

# 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 UI, meltano config, or an environment variable:

meltano config tap-gitlab set projects "<namespace1/project1> <namespace2/project2>"

export TAP_GITLAB_PROJECTS="<namespace1/project1> <namespace2/project2>"

# For example:
meltano config tap-gitlab set projects meltano/meltano
meltano config tap-gitlab set projects "meltano/meltano meltano/tap-gitlab"

export TAP_GITLAB_PROJECTS=meltano/meltano
export TAP_GITLAB_PROJECTS="meltano/meltano meltano/tap-gitlab"

# Ultimate License

  • Name: 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

  • Name: fetch_merge_request_commits
  • Environment variable: TAP_GITLAB_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.

# 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

  • Name: fetch_pipelines_extended
  • Environment variable: TAP_GITLAB_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.

# 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

This property 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

# For example:
meltano config tap-gitlab set start_date 2020-10-01T00:00:00Z

export TAP_GITLAB_START_DATE=2020-10-01T00:00:00Z