Skip to content

Commit

Permalink
User develops override (#4831)
Browse files Browse the repository at this point in the history
## What are you changing in this pull request and why?

New option in dbt Cloud to override the dbt version used for projects.

- Add new **Override dbt version** section to [Upgrade Core version in
Cloud](https://docs.getdbt.com/docs/dbt-versions/upgrade-core-in-cloud)
page
- Create release note

## 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] For [docs
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#about-versioning),
review how to [version a whole
page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
and [version a block of
content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content).
- [x] Needs review from product eng

Adding or removing pages (delete if not applicable):
- ~~[ ] Add/remove page in `website/sidebars.js`~~ N/A autogenerated for
release notes
- [x] Provide a unique filename for new pages
  • Loading branch information
nghi-ly authored Feb 2, 2024
2 parents 04c3ea2 + 834c056 commit 6b703dc
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "New: Override dbt version with new User development settings"
description: "February 2024: Test new dbt features on your user account before safely upgrading the dbt version in your development environment."
sidebar_label: "New: Override dbt version"
sidebar_position: 10
tags: [Feb-2024]
date: 2024-02-02
---

You can now [override the dbt version](/docs/dbt-versions/upgrade-core-in-cloud#override-dbt-version) that's configured for the development environment within your project and use a different version — affecting only your user account. This lets you test new dbt features without impacting other people working on the same project. And when you're satisfied with the test results, you can safely upgrade the dbt version for your project(s).

Use the **dbt version** dropdown to specify the version to override with. It's available on your project's credentials page in the **User development settings** section. For example:

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/choosing-dbt-version/example-override-version.png" title="Example of overriding the dbt version on your user account"/>

27 changes: 24 additions & 3 deletions website/docs/docs/dbt-versions/upgrade-core-in-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,38 @@ title: "Upgrade Core version in Cloud"
id: "upgrade-core-in-cloud"
---

In dbt Cloud, both jobs and environments are configured to use a specific version of dbt Core. The version can be upgraded at any time.
In dbt Cloud, both [jobs](/docs/deploy/jobs) and [environments](/docs/dbt-cloud-environments) are configured to use a specific version of dbt Core. The version can be upgraded at any time.

### Environments
## Environments

Navigate to the settings page of an environment, then click **edit**. Click the **dbt Version** dropdown bar and make your selection. From this list, you can select an available version of Core to associate with this environment.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/choosing-dbt-version/Environment-settings.png" title="Settings of a dbt Cloud environment"/>

Be sure to save your changes before navigating away.

### Jobs
### Override dbt version

Configure your project to use a different dbt Core version than what's configured in your [development environment](/docs/dbt-cloud-environments#types-of-environments). This _override_ only affects your user account, no one else's. Use this to safely test new dbt features before upgrading the dbt version for your projects.

1. From the gear menu, select **Profile settings**.
1. Choose **Credentials** from the sidebar and select a project. This opens a side panel.
1. In the side panel, click **Edit** and scroll to the **User development settings** section. Choose a version from the **dbt version** dropdown and click **Save**. When saving, dbt Cloud automatically creates a `DBT_DEVELOP_CORE_VERSION` environment variable for this user-level override and lists it in the **Environment variables** section.

An example of overriding the configured version with 1.7 for the selected project:

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/choosing-dbt-version/example-override-version.png" title="Example of overriding the dbt version on your user account"/>

1. (Optional) Verify that dbt Cloud will use your override setting to build the project. Invoke `dbt build` in the IDE's command bar. Expand the **System Logs** section and find the output's first line. It should begin with `Running with dbt=` and list the version dbt Cloud is using.

Example output of a successful `dbt build` run:

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/choosing-dbt-version/example-verify-overridden-version.png" title="Example output showing version 1.7 being used, not 1.5"/>

1. If you upgrade the version for your development environment, make sure to delete the `DBT_DEVELOP_CORE_VERSION` environment variable from the **Environment variables** section in your project's credentials.


## Jobs

Each job in dbt Cloud can be configured to inherit parameters from the environment it belongs to.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b703dc

Please sign in to comment.