Skip to content

Update connect-gitlab.md #7216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: current
Choose a base branch
from
Open
13 changes: 11 additions & 2 deletions website/docs/docs/cloud/git/connect-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,19 @@ Connecting your GitLab account to <Constant name="cloud" /> provides convenience

:::info
When configuring the repository in <Constant name="cloud" />, GitLab automatically:
- Registers a webhook, which triggers pipeline jobs in <Constant name="cloud" />.
- Registers a webhook that triggers pipeline jobs in <Constant name="cloud" />.
- Creates a [project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html) in your GitLab repository, which sends the job run status back to GitLab using the <Constant name="cloud" /> API for CI jobs. <Constant name="cloud" /> automatically refreshes this token for you, which means you never have to manually rotate it. Check out the [troubleshooting](#troubleshooting) section for more information.

:::

The steps to integrate GitLab in <Constant name="cloud" /> depend on your plan. If you are on:
Depending on your plan, use these steps to integrate GitLab in <Constant name="cloud" />:
- the Developer or Team plan, read these [instructions](#for-dbt-cloud-developer-and-team-tiers).
- the Enterprise plan, jump ahead to these [instructions](#for-the-dbt-cloud-enterprise-tier).

## For dbt Cloud Developer and Team tiers

Before you can work with GitLab repositories in <Constant name="cloud" />, you’ll need to connect your GitLab account to your user profile. This allows <Constant name="cloud" /> to authenticate your actions when interacting with Git repositories. Make sure to read about [limitations](#limitations) of the Team and Developer plans before you connect your account.

To connect your GitLab account:
1. From <Constant name="cloud" />, click on your account name in the left side menu and select **Account settings**.
2. Select **Personal profile** under the **Your profile** section.
Expand All @@ -38,6 +40,13 @@ When you click **Link**, you will be redirected to GitLab and prompted to sign i

Once you've accepted, you should be redirected back to <Constant name="cloud" />, and you'll see that your account has been linked to your profile.

### Limitations

Because <Constant name="cloud" /> Team plans use a single GitLab deploy token that's tied to the user who connected the repo, they are limited in the following ways when using GitLab:
* Push rules aren't supported
* Only the user who originally connected the repository can commit changes

To enable multi-user commit access, you’ll need an Enterprise plan, which supports deploy tokens that aren't tied to a specific user.

## For the dbt Cloud Enterprise tier

Expand Down
Loading