Skip to content
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

Fast-follows for merge jobs #5308

Merged
merged 10 commits into from
Apr 22, 2024
Merged

Fast-follows for merge jobs #5308

merged 10 commits into from
Apr 22, 2024

Conversation

nghi-ly
Copy link
Contributor

@nghi-ly nghi-ly commented Apr 18, 2024

What are you changing in this pull request and why?

Checklist

  • Review the Content style guide so my content adheres to these guidelines.
  • Needs review from PM

@nghi-ly nghi-ly requested a review from a team as a code owner April 18, 2024 22:26
Copy link

vercel bot commented Apr 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 22, 2024 4:18pm

@github-actions github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides labels Apr 18, 2024
@nghi-ly nghi-ly requested a review from reubenmc April 18, 2024 22:26
@github-actions github-actions bot added size: small This change will take 1 to 2 days to address Docs team Authored by the Docs team @dbt Labs labels Apr 18, 2024
@nghi-ly nghi-ly requested a review from joellabes April 18, 2024 22:26
@@ -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).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for consistency and parallel construction, new callout on line 61 follows this ^ format


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

active voice sugg

Suggested change
- 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.
- 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 GitLab won't report back the CI job status updates (success or failure of the job).

Copy link
Contributor Author

@nghi-ly nghi-ly Apr 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

like your sugg but it changes the meaning of the sentence (updates not reported to GitLab vs GitLab not reporting updates)

@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤩

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks awesome, thanks @nghi-ly and small non blocker from me!

@nghi-ly nghi-ly merged commit 5acf488 into current Apr 22, 2024
11 checks passed
@nghi-ly nghi-ly deleted the ly-docs-add-callout branch April 22, 2024 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto update content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants