Already have an account? Sign in

GitLab (v1)

GitLab integration summary

Stitch’s GitLab integration replicates data using theGitLab REST API. Refer to theSchema section for a list of objects available for replication.

GitLab feature snapshot

A high-level look at Stitch's GitLab (v1) integration, including release status, useful links, and the features supported in Stitch.

Connecting GitLab

GitLab setup requirements

To set up GitLab in Stitch, you need:

• Access to any projects you want to replicate data from. Stitch will only be able to access the same projects as the user who creates the integration.

Step 1: Create a GitLab token

1. Sign into your GitLab account.
2. Click theuser menu (your icon) > Settings.
3. Click theAccess Tokens tab.
4. In theName field, enterStitch. This will allow you to easily identify what application is using the token.
5. In theScopes section, check theapi box. This will allow Stitch to access your API and replicate your GitLab data.
6. ClickCreate Personal Access Token.
7. The new Access Token will display at the top of the page.Copy the token before navigating away from the page - GitLab won’t display it again.

Step 2: Add GitLab as a Stitch data source

1. Sign into your Stitch account.

2. On the Stitch Dashboard page, click theAdd Integration button.

3. Click theGitLab icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch GitLab” would create a schema calledstitch_gitlab in the destination.Note: Schema names cannot be changed after you save the integration.

5. In theAPI URL field, enterhttps://gitlab.com/api/v4.
6. In thePrivate Token field, paste thePersonal Access Token you created in the previous section.

7. In theProjects andGroups to Track fields, you’ll enter the projects and/or groups you want to track as aspace-separated list.

   For example:stitchdata/group-a, orstitchdata/project-a stitchdata/project-b

   Note: A value for one of these fields must be provided. Additionally, the way you define these settings determines how some data is replicated:

   • Ifgroups are provided butprojects aren’t, all group projects will be replicated.
   • Ifgroups andprojects are provided, the selected projects of the listed groups will be replicated.
   • Ifprojects are provided butgroups aren’t, all listed projects will be replicated.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your GitLab integration. This means that dataequal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond GitLab’s default setting of1 year. For a detailed look at historical replication jobs, check out theSyncing Historical SaaS Data guide.

Step 4: Create a replication schedule

In theReplication Frequency section, you’ll create the integration’sreplication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

GitLab integrations support the following replication scheduling methods:

• Replication Frequency

• Anchor Scheduling

• Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See theUnderstanding and Reducing Your Row Usage guide for tips on reducing your usage.

Initial and historical replication jobs

After you finish setting up GitLab, itsSync Status may show asPending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, aPending status indicates that Stitch is in the process of scheduling the initial replication job for the integration.This may take some time to complete.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

GitLab table reference

branches.project_id = commits.project_id

branches.commit_id = commits.id

branches.project_id = issues.project_id

branches.project_id = milestones.project_id

branches.project_id = projects.project_id

commits.project_id = branches.project_id

commits.id = branches.commit_id

commits.project_id = issues.project_id

commits.project_id = milestones.project_id

commits.project_id = projects.project_id

issues.project_id = branches.project_id

issues.project_id = commits.project_id

issues.project_id = milestones.project_id

issues.milestone_id = milestones.id

issues.project_id = projects.project_id

milestones.project_id = branches.project_id

milestones.project_id = commits.project_id

milestones.project_id = issues.project_id

milestones.id = issues.milestone_id

milestones.project_id = projects.project_id

projects.project_id = branches.project_id

projects.project_id = commits.project_id

projects.project_id = issues.project_id

projects.project_id = milestones.project_id

projects.creator_id = users.id

users.id = projects.creator_id

Did this article help? If you have questions or feedback, feel free tosubmit a pull request with your suggestions,open an issue on GitHub, orreach out to us.