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

Update upgrade-dbt-version-in-cloud.md #6748

Merged
merged 26 commits into from
Jan 10, 2025
Merged
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
e5689d0
clarify ado behavior
mirnawong1 Dec 20, 2024
f741d87
Update website/docs/docs/build/packages.md
mirnawong1 Dec 20, 2024
ab8fd7a
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Dec 20, 2024
b5ac123
Update packages.md
mirnawong1 Dec 20, 2024
d675e8f
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Dec 23, 2024
ca11bf5
Merge branch 'current' into mirnawong1-patch-28
runleonarun Dec 24, 2024
635c4e2
Update website/docs/docs/build/packages.md
mirnawong1 Dec 24, 2024
5ca94db
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Dec 24, 2024
389792d
change title
mirnawong1 Dec 24, 2024
bf81383
fix conflict
mirnawong1 Dec 24, 2024
d032be9
clarify consideration
mirnawong1 Dec 24, 2024
f876964
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Dec 24, 2024
2013e7f
Update upgrade-dbt-version-in-cloud.md
mirnawong1 Jan 9, 2025
3611364
Update upgrade-dbt-version-in-cloud.md
mirnawong1 Jan 9, 2025
8ad4749
Update website/docs/docs/dbt-versions/upgrade-dbt-version-in-cloud.md
mirnawong1 Jan 9, 2025
4745203
Update website/docs/docs/dbt-versions/upgrade-dbt-version-in-cloud.md
mirnawong1 Jan 9, 2025
2a22de2
update branch locally
mirnawong1 Jan 9, 2025
65d6979
add new images
mirnawong1 Jan 9, 2025
2e7f31e
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Jan 9, 2025
2f9dcb7
Update upgrade-dbt-version-in-cloud.md
mirnawong1 Jan 9, 2025
9b51f19
remove img
mirnawong1 Jan 9, 2025
ee6e19d
add brk
mirnawong1 Jan 9, 2025
0cfaeb2
readd img and delete correct one
mirnawong1 Jan 9, 2025
50c3bd7
Update upgrade-dbt-version-in-cloud.md
mirnawong1 Jan 9, 2025
87fa226
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Jan 10, 2025
eaedb96
Merge branch 'current' into mirnawong1-patch-28
mirnawong1 Jan 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions website/docs/docs/dbt-versions/upgrade-dbt-version-in-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ To upgrade an environment in the [dbt Cloud Admin API](/docs/dbt-cloud-apis/admi
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. Click your account name from the left side panel and select **Account 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**.
2. Choose **Credentials** from the sidebar and select a project. This opens a side panel.
3. 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**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Hiya @mirnawong1

This is a non-blocker. Would it be worth using a versionless image (to silently encourage people to upgrade to versionless)? I can grab one for you if you like?

Kind Regards
Natalie

Copy link
Contributor Author

Choose a reason for hiding this comment

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

was this something you were going to address in your ui project? i noticed the images were old but wasn’t sure if you were addressing this already. if not, i can add a screenshot even though its out of scope of the pr


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" width="60%" 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.
4. (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:

Expand Down Expand Up @@ -298,13 +298,16 @@ If you believe your project might be affected, read more details in the migratio


#### Testing your changes before upgrading
Once you know what code changes you'll need to make, you can start implementing them. We recommend you create a separate dbt project, **Upgrade Project**, to test your changes before making them live in your main dbt project. In your **Upgrade Project**, connect to the same repository you use for your production project. This time, set the development environment [settings](/docs/dbt-versions/upgrade-dbt-version-in-cloud) to run the latest version of dbt Core. Next, check out a branch `dbt-version-upgrade`, make the appropriate updates to your project, and verify your dbt project compiles and runs with the new version in the IDE. If upgrading directly to the latest version results in too many issues, try testing your project iteratively on successive minor versions. There are years of development and a few breaking changes between distant versions of dbt Core (for example, 0.14 --> 1.0). The likelihood of experiencing problems upgrading between successive minor versions is much lower, which is why upgrading regularly is recommended.

Once you have your project compiling and running on the latest version of dbt in the development environment for your `dbt-version-upgrade` branch, try replicating one of your production jobs to run off your branch's code. You can do this by creating a new deployment environment for testing, setting the custom branch to 'ON' and referencing your `dbt-version-upgrade` branch. You'll also need to set the dbt version in this environment to the latest dbt Core version.



<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/cloud-upgrading-dbt-versions/upgrade-environment.png" title="Setting your testing environment" />


Then add a job to the new testing environment that replicates one of the production jobs your team relies on. If that job runs smoothly, you should be all set to merge your branch into main and change your development and deployment environments in your main dbt project to run off the newest version of dbt Core.
Once you know what code changes you'll need to make, you can start implementing them. We recommend you:
- Create a separate dbt project, **Upgrade project**, to test your changes before making them live in your main dbt project.
mirnawong1 marked this conversation as resolved.
Show resolved Hide resolved
- In your **Upgrade project**, connect to the same repository you use for your production project.
- Set the development environment [settings](/docs/dbt-versions/upgrade-dbt-version-in-cloud) to run the latest version of dbt Core.
- Check out a branch `dbt-version-upgrade`, make the appropriate updates to your project, and verify your dbt project compiles and runs with the new version in the dbt Cloud IDE.
- If upgrading directly to the latest version results in too many issues, try testing your project iteratively on successive minor versions. There are years of development and a few breaking changes between distant versions of dbt Core (for example, 0.14 --> 1.0). The likelihood of experiencing problems upgrading between successive minor versions is much lower, which is why upgrading regularly is recommended.
- Once you have your project compiling and running on the latest version of dbt in the development environment for your `dbt-version-upgrade` branch, try replicating one of your production jobs to run off your branch's code.
- You can do this by creating a new deployment environment for testing, setting the custom branch to 'ON' and referencing your `dbt-version-upgrade` branch. You'll also need to set the dbt version in this environment to the latest dbt Core version.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/cloud-upgrading-dbt-versions/upgrade-environment.png" width="80%" title="Setting your testing environment" />

- Then add a job to the new testing environment that replicates one of the production jobs your team relies on.
- If that job runs smoothly, you should be all set to merge your branch into main and change your development and deployment environments in your main dbt project to run off the newest version of dbt Core.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- If that job runs smoothly, you should be all set to merge your branch into main and change your development and deployment environments in your main dbt project to run off the newest version of dbt Core.
- If that job runs smoothly, you should be all set to merge your branch into main and, change your development and deployment environments in your main dbt project to run off the newest version of dbt Core.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hiya @mirnawong1

I've added this comma to break the sentence up a bit

Kind Regards
Natalie

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks @nataliefiann , not sure if the command should go before the 'and'. but i turned it into two separate bullets

Loading