Below is an example of what the PR content included in the Upgrading dbt Core Version(s) Guide document would preview as.
Description:
Upgrade dbt versions from vx.x.x to v.z.z.z.
Links/references:
The link to dbt's general document regarding dbt Core versions: link
The link to dbt's version specific upgrade details: link (v1.5 linked as an example)
Upgrade Process Check-list:
[ ] Create an issue
[ ] Create an upgrade branch
[ ] Update the dbt version parameters version and require-dbt-version in dbt_project.yml
[ ] Update packages.yml
[ ] Review relevant package documentation and be careful of breaking changes that could be introduced when upgrading packages.
[ ] Document all relevant breaking changes in their own issue and list these sub-issues in the main issue's Related Issues section.
[ ] For issues that need to be resolved before the upgrade is completed, include the code changes in the dbt-upgrade-test branch.
[ ] Set the dbt version for a testing environment
[ ] Create a new project environment for testing.
[ ] Edit the dbt Version Settings parameter and specify the new version of dbt.
[ ] Toggle/check Only run on a custom branch.
[ ] Enter in the Custom Branch field the name of the testing branch.
[ ] Create a job in the new environment that replicates the project's production environment build all job.
[ ] Test the project compatibility with the new version by manually running the build all job.
[ ] The job ran successfully.
[ ] The job did not run successfully.
[ ] Identify, document, and resolve all the issues.
[ ] Identify and document the issue(s) in their own issue and list these sub-issues in the main issue's Related Issues section.
[ ] For issues that need to be resolved before the upgrade is completed, include the code changes in the dbt-upgrade-test branch.
[ ] Update requirements.txt for dbt Core
[ ] Update the dbt Core package, dbt-core, and the adapter plugin , dbt-snowflake, in the requirements.txt file in the testing branch, dbt-upgrade-test.
[ ] Update the secondary packages.
[ ] Review relevant package documentation and be careful of breaking changes that could be introduced when upgrading packages.
[ ] Document all relevant breaking changes in their own issue and list these sub-issues in the main issue's Related Issues section.
[ ] For issues that need to be resolved before the upgrade is completed, include the code changes in the dbt-upgrade-test branch.
[ ] Finalize and complete the upgrade
[ ] Open and fill out the PR sections completely.
[ ] Assign reviewers.
[ ] After the final approval, in dbt Cloud, update all of the remaining environments (unless otherwise stated).
[ ] Verify all of the PR CI/CD checks pass.
[ ] Merge and close the PR.
[ ] If the main issue ticket is automatically closed by this PR, open it if there are remaining sub-issues needed to be addressed post upgrade.
Related issues that can be closed by this PR:
Link and list the sub-issues that are listed in the main issue's Related Issues section using a closing keyword so the issues will be automatically closed by this PR.
Resolves issue #X
Additional Notes/Comments
Developers/analysts using dbt Core should upgrade their local workstations using the specifications in the requirements.txt after this PR has been merged.
Developers/analysts using dbt Cloud do not need to take any additional action after this PR has been merged to continue their work.
Below is an example of what the PR content included in the Upgrading dbt Core Version(s) Guide document would preview as.
Description:
Upgrade dbt versions from vx.x.x to v.z.z.z.
Links/references:
The link to dbt's general document regarding dbt Core versions: link The link to dbt's version specific upgrade details: link (v1.5 linked as an example)
Upgrade Process Check-list:
[ ] Create an issue
[ ] Create an upgrade branch
[ ] Update the dbt version parameters
version
andrequire-dbt-version
indbt_project.yml
[ ] Update
packages.yml
dbt-upgrade-test
branch.[ ] Set the dbt version for a testing environment
[ ] Test the project compatibility with the new version by manually running the build all job.
dbt-upgrade-test
branch.[ ] Update
requirements.txt
for dbt Coredbt-core
, and the adapter plugin ,dbt-snowflake
, in therequirements.txt
file in the testing branch,dbt-upgrade-test
.dbt-upgrade-test
branch.[ ] Finalize and complete the upgrade
Related issues that can be closed by this PR:
Link and list the sub-issues that are listed in the main issue's Related Issues section using a closing keyword so the issues will be automatically closed by this PR.
Additional Notes/Comments
requirements.txt
after this PR has been merged.