Skip to content

Commit

Permalink
Fast-follows for merge jobs (#5308)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

- Add callout to CI/CD guide
https://docs.getdbt.com/guides/custom-cicd-pipelines?step=1 that points
to Merge jobs page
- Update prerequisites for Merge jobs

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
- [x] Needs review from PM
  • Loading branch information
nghi-ly authored Apr 22, 2024
2 parents f8947a5 + 6fe9d3e commit 5acf488
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
5 changes: 3 additions & 2 deletions website/docs/docs/deploy/merge-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@ sidebar_label: "Merge jobs"
description: "Learn how to trigger a dbt job run when a Git pull request merges."
---

# Merge jobs in dbt Cloud <Lifecycle status="beta" />

You can set up a merge job to implement a continuous development (CD) workflow in dbt Cloud. The merge job triggers a dbt job to run when someone merges Git pull requests into production. This creates a seamless development experience where changes made in code will automatically update production data.

By using CD in dbt Cloud, you can take advantage of deferral to build only the edited model and any downstream changes. With merge jobs, state will be updated almost instantly, always giving the most up-to-date state information in [dbt Explorer](/docs/collaborate/explore-projects).

## Prerequisites
- You have a dbt Cloud account.
- You have access to the beta release for this functionality.
- You have set up a [connection with your Git provider](/docs/cloud/git/git-configuration-in-dbt-cloud). This integration lets dbt Cloud run jobs on your behalf for job triggering.
- If you're using a native [GitLab](/docs/cloud/git/connect-gitlab) integration, you need a paid or self-hosted account that includes support for GitLab webhooks and [project access tokens](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html). If you're using GitLab Free, merge requests will trigger CI jobs but CI job status updates (success or failure of the job) will not be reported back to GitLab.
- You are set up to receive push notifications from your Git provider. For details, refer to [Job notifications](/docs/deploy/job-notifications).

## Set up job trigger on Git merge {#set-up-merge-jobs}

Expand Down
8 changes: 7 additions & 1 deletion website/docs/guides/custom-cicd-pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,12 @@ Here’s a quick look at what this pipeline will accomplish:

This job will take a bit more to setup, but is a good example of how to call the dbt Cloud API from a CI/CD pipeline. The concepts presented here can be generalized and used in whatever way best suits your use case.

:::tip Run on merge

If your Git provider has a native integration with dbt Cloud, you can take advantage of setting up [Merge jobs](/docs/deploy/merge-jobs) in the UI.

:::

The setup below shows how to call the dbt Cloud API to run a job every time there's a push to your main branch (The branch where pull requests are typically merged. Commonly referred to as the main, primary, or master branch, but can be named differently).

### 1. Get your dbt Cloud API key
Expand Down Expand Up @@ -509,7 +515,7 @@ Additionally, you’ll see the job in the run history of dbt Cloud. It should be

If your git provider is not one with a native integration with dbt Cloud, but you still want to take advantage of CI builds, you've come to the right spot! With just a bit of work it's possible to setup a job that will run a dbt Cloud job when a pull request (PR) is created.

:::info Run on PR
:::tip Run on PR

If your git provider has a native integration with dbt Cloud, you can take advantage of the setup instructions [here](/docs/deploy/ci-jobs).
This section is only for those projects that connect to their git repository using an SSH key.
Expand Down

0 comments on commit 5acf488

Please sign in to comment.