Skip to content

Commit

Permalink
add gitlab webhook faq (#6635)
Browse files Browse the repository at this point in the history
  • Loading branch information
mirnawong1 authored Dec 10, 2024
2 parents 18cd693 + 113906b commit ff575ce
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 12 deletions.
15 changes: 3 additions & 12 deletions website/docs/docs/cloud/git/connect-gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Connecting your GitLab account to dbt Cloud provides convenience and another lay
- Clone repos using HTTPS rather than SSH.
- Carry GitLab user permissions through to dbt Cloud or dbt Cloud CLI's git actions.
- Trigger [Continuous integration](/docs/deploy/continuous-integration) builds when merge requests are opened in GitLab.
- GitLab automatically registers a webhook in your GitLab repository to enable seamless integration with dbt Cloud.

The steps to integrate GitLab in dbt Cloud depend on your plan. If you are on:
- the Developer or Team plan, read these [instructions](#for-dbt-cloud-developer-and-team-tiers).
Expand Down Expand Up @@ -114,20 +115,10 @@ If your GitLab account is not connected, you’ll see "No connected account". Se

Once you approve authorization, you will be redirected to dbt Cloud, and you should see your connected account. You're now ready to start developing in the dbt Cloud IDE or dbt Cloud CLI.


## Troubleshooting

### Errors when importing a repository on dbt Cloud project set up
If you do not see your repository listed, double-check that:
- Your repository is in a Gitlab group you have access to. dbt Cloud will not read repos associated with a user.

If you do see your repository listed, but are unable to import the repository successfully, double-check that:
- You are a maintainer of that repository. Only users with maintainer permissions can set up repository connections.

If you imported a repository using the dbt Cloud native integration with GitLab, you should be able to see the clone strategy is using a `deploy_token`. If it's relying on an SSH key, this means the repository was not set up using the native GitLab integration, but rather using the generic git clone option. The repository must be reconnected in order to get the benefits described above.

## FAQs

<FAQ path="Troubleshooting/gitlab-webhook"/>
<FAQ path="Troubleshooting/error-importing-repo"/>
<FAQ path="Git/gitignore"/>
<FAQ path="Git/gitlab-authentication"/>
<FAQ path="Git/gitlab-selfhosted"/>
Expand Down
3 changes: 3 additions & 0 deletions website/docs/docs/deploy/ci-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,8 @@ To validate _all_ semantic nodes in your project, add the following command to d

## Troubleshooting

<FAQ path="Troubleshooting/gitlab-webhook"/>

<DetailsToggle alt_header="Temporary schemas aren't dropping">
If your temporary schemas aren't dropping after a PR merges or closes, this typically indicates one of these issues:
- You have overridden the <code>generate_schema_name</code> macro and it isn't using <code>dbt_cloud_pr_</code> as the prefix.
Expand All @@ -201,6 +203,7 @@ A macro is creating a schema but there are no dbt models writing to that schema.

</DetailsToggle>


<DetailsToggle alt_header="Error messages that refer to schemas from previous PRs">

If you receive a schema-related error message referencing a <i>previous</i> PR, this is usually an indicator that you are not using a production job for your deferral and are instead using <i>self</i>. If the prior PR has already been merged, the prior PR's schema may have been dropped by the time the CI job for the current PR is kicked off.
Expand Down
14 changes: 14 additions & 0 deletions website/docs/faqs/Troubleshooting/error-importing-repo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Errors importing a repository on dbt Cloud project set up
description: "Errors importing a repository on dbt Cloud project set up"
sidebar_label: 'Errors importing a repository on dbt Cloud project set up'
id: error-importing-repo
---

If you don't see your repository listed, double-check that:
- Your repository is in a Gitlab group you have access to. dbt Cloud will not read repos associated with a user.

If you do see your repository listed, but are unable to import the repository successfully, double-check that:
- You are a maintainer of that repository. Only users with maintainer permissions can set up repository connections.

If you imported a repository using the dbt Cloud native integration with GitLab, you should be able to see if the clone strategy is using a `deploy_token`. If it's relying on an SSH key, this means the repository was not set up using the native GitLab integration, but rather using the generic git clone option. The repository must be reconnected in order to get the benefits described above.
19 changes: 19 additions & 0 deletions website/docs/faqs/Troubleshooting/gitlab-webhook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: Unable to trigger a CI job with GitLab
description: "Unable to trigger a CI job"
sidebar_label: 'Unable to trigger a CI job'
id: gitlab-webhook
---

When you connect dbt Cloud to a GitLab repository, GitLab automatically registers a webhook in the background, viewable under the repository settings. This webhook is also used to trigger [CI jobs](/docs/deploy/ci-jobs) when you push to the repository.

If you're unable to trigger a CI job, this usually indicates that the webhook registration is missing or incorrect.

To resolve this issue, navigate to the repository settings in GitLab and view the webhook registrations by navigating to GitLab --> **Settings** --> **Webhooks**.

Some things to check:

- The webhook registration is enabled in GitLab.
- The webhook registration is configured with the correct URL and secret.

If you're still experiencing this issue, reach out to the Support team at [email protected] and we'll be happy to help!

0 comments on commit ff575ce

Please sign in to comment.