GitLab
Table of Contents
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:
Installation and configuration #
-
Add the
tap-gitlab
extractor to your project usingmeltano add
:meltano add extractor tap-gitlab
-
Configure the settings below using
meltano config
.
Next steps #
Follow the remaining steps of the Getting Started guide:
- Select entities and attributes to extract
- Add a loader to send data to a destination
- Run a data integration (EL) pipeline
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
)
#
-
Environment variable:
TAP_GITLAB_API_URL
- Default:
https://gitlab.com
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
)
#
-
Environment variable:
TAP_GITLAB_PRIVATE_TOKEN
- Default:
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:
-
Navigate to your profile’s access tokens.
-
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
-
Click on
Create personal access token
to submit your request. -
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
)
#
-
Environment variable:
TAP_GITLAB_GROUPS
- Default:
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
)
#
-
Environment variable:
TAP_GITLAB_PROJECTS
- Default:
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:
meltano/meltano
- The core Meltano projectmeltano/sdk
- The project for the Meltano SDK for Singer Taps and Targets
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
)
#
-
Environment variable:
TAP_GITLAB_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.
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
)
#
-
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.
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
)
#
-
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.
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
)
#
-
Environment variable:
TAP_GITLAB_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!