-
Notifications
You must be signed in to change notification settings - Fork 982
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
Changes to docs due to 0.20/1 deprecation #2534
Changes from 1 commit
4294a0b
b3fe09d
ee49e34
1404f09
86d04da
d3ffd5b
c37f5d4
c6ce1c5
ec706d3
2daa232
32fea35
25b329b
588e7e7
a492cb6
58d8726
35a362c
6066e92
4712841
22492d2
988c8a2
8402726
5dc8e1a
965db08
9c8a139
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,14 +15,6 @@ exports.versions = [ | |
version: "1.0", | ||
EOLDate: "2022-12-03" | ||
}, | ||
{ | ||
version: "0.21", | ||
EOLDate: "2022-06-30" | ||
}, | ||
{ | ||
version: "0.20", | ||
EOLDate: "2022-06-30" | ||
} | ||
Comment on lines
-18
to
-25
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 |
||
] | ||
|
||
exports.versionedPages = [ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,12 +32,7 @@ We will continue to update this table so that customers know when we plan to sto | |
|
||
<Snippet src="core-versions-table" /> | ||
|
||
|
||
:::warning ⚠️ v0.X Non-Supported Period | ||
Accounts had until the end of June 2022 to upgrade to dbt 1.0 or later. Pre-dbt 1.0 versions will no longer receive patch fixes, and our support team will no longer assist with dbt version specific help on non-supported versions of dbt. Additionally, jobs running dbt versions prior to 1.0 may experience service disruptions before the end of the year and may be removed from the dbt Cloud context by year end. You will receive additional notification before any planned disruption to your production jobs. | ||
::: | ||
Comment on lines
-36
to
-38
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is there a version of this text that we want to leave in for now, relating to pre-1.0 versions? We've been providing a lot of messaging to folks in Cloud over the course of the year, if they're using unsupported versions, but we have yet to formally remove those older versions from Cloud, or force upgrades. I don't know to what extent we still need that fact to be reflected here in the public does site. (cc @schottj) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @jtcohen6 would it make sense to put the message back but make it about 1.0 and give a warning about the cloud versions if/when we have a solid date for deprecation? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @matthewshaver Good call. Here's a draft of an proposed update message for this page:
Meta context for our teams: For now, our focus + priority is on the very small number of accounts/customers who are still using v0.x. Once that's sorted (~March), we'll turn our attention to automating upgrades for folks who are on v1.0, given that they can most likely start using v1.1 safely, without any code changes. I don't think we need to state that in the docs explicitly, until we have a clear public date for v1.0 deprecation. |
||
|
||
Starting in v1.0, dbt Cloud will ensure that you're always using the latest compatible patch release of `dbt-core` and plugins, including all the latest fixes. You may also choose to try prereleases of those patch releases before they are generally available. | ||
Starting with v1.0, dbt Cloud will ensure that you're always using the latest compatible patch release of `dbt-core` and plugins, including all the latest fixes. You may also choose to try prereleases of those patch releases before they are generally available. | ||
|
||
<!--- TODO: Include language to reflect: | ||
- notifying users when new minor versions are available | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,9 @@ id: "core" | |
description: "Learn about semantic versioning for dbt Core, and how long those versions are supported." | ||
--- | ||
|
||
dbt Core releases follow [semantic versioning](https://semver.org/). The policies and expectations on this page assume prior familiarity with semantic versions. For more on how we use semantic versions, see [How dbt Core uses semantic versioning](#how-dbt-core-uses-semantic-versioning). | ||
dbt Core releases follow [semantic versioning](https://semver.org/) guidelines. For more on how we use semantic versions, see [How dbt Core uses semantic versioning](#how-dbt-core-uses-semantic-versioning). | ||
|
||
<Snippet src="core-versions-table" /> | ||
|
||
### Further reading | ||
|
||
|
@@ -14,23 +16,21 @@ dbt Core releases follow [semantic versioning](https://semver.org/). The policie | |
|
||
## Version support prior to v1.0 | ||
|
||
- We are no longer releasing new patches for minor versions prior to v1.0. | ||
- As of June 30, 2022, dbt Cloud will remove support for dbt Core versions older than v1.0. At that point, we will also remove v0.20 and v0.21 from the version dropdown on this website. | ||
- You can read the [specific version migration guides](/guides/migration/versions) to understand changes to each version. Each migration guide will link to pages of documentation that were added or updated. Those pages of documentation will also include "Changelog" notes, which you can toggle to see notes on specific changes from each older version. | ||
All dbt Core versions released prior to 1.0 and their version-specific documentation have been deprecated. If upgrading to a currently supported version, reference our [best practices for upgrading](#best-practices-for-upgrading) | ||
|
||
## Version support starting with v1.0 | ||
## Current version support | ||
|
||
### Minor version support | ||
### Minor versions | ||
|
||
Minor versions include new features and capabilities. They will be supported for one year (12 months) from the date of their initial release. _This is a definite commitment._ Our mechanism for continuing to support a minor version is by releasing new patches: small, targeted bug fixes. Whenever we refer to a minor version, such as v1.0, we always mean its latest available patch release (v1.0.x). | ||
Minor versions include new features and capabilities. They will be supported for one year from the date of their initial release. _dbt Labs is committed to this 12 month support window._ Our mechanism for continuing to support a minor version is by releasing new patches: small, targeted bug fixes. Whenever we refer to a minor version, such as v1.0, we always mean its latest available patch release (v1.0.x). | ||
matthewshaver marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
While a minor version is officially supported: | ||
- You can use it in dbt Cloud. For more on dbt Cloud versioning, see [Choosing a dbt version](cloud-choosing-a-dbt-version). | ||
- You can select it from the version dropdown on this website, to see documentation that is accurate for use with that minor version. | ||
|
||
### Ongoing patches | ||
|
||
During the 12 months of ongoing support, we will continue to release new patch versions that include fixes. | ||
During the 12 month support window, we will continue to release new patch versions that include fixes. | ||
matthewshaver marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
**Active Support:** In the first few months after a minor version's initial release, we will patch it with "bugfix" releases. These will include fixes for regressions and net-new bugs that were present in the minor version's original release. | ||
|
||
|
@@ -42,12 +42,6 @@ After a minor version reaches the end of its critical support period, one year a | |
|
||
We aim to release a new minor "feature" every 3 months. _This is an indicative timeline ONLY._ For the latest information about upcoming releases, including their planned release dates and which features and fixes might be included in each, always consult the [`dbt-core` repository milestones](https://github.com/dbt-labs/dbt-core/milestones). | ||
|
||
<Snippet src="core-versions-table" /> | ||
|
||
:::warning ⚠️ v0.X Non-Supported Period | ||
We are giving accounts until the end of June 2022 to upgrade to dbt 1.0 or later. Pre-dbt 1.0 versions will not receive patch fixes, and our support team will no longer assist with dbt version specific help on non-supported versions of dbt. Additionally, jobs running dbt versions prior to 1.0 will start experiencing service disruptions before the end of the year 2022 and will be removed from the dbt Cloud context by end of the year 2022. You will receive additional email and in app notification before disruption to your production jobs. | ||
::: | ||
|
||
## Best practices for upgrading | ||
|
||
Because of our new version practice, we've outlined best practices and expectations for dbt users to upgrade as we continue to release new versions of dbt Core. | ||
|
@@ -58,7 +52,7 @@ We expect users to upgrade to patches as soon as they're available. When we refe | |
|
||
### Upgrading to new minor versions | ||
|
||
You may continue to use any minor version of dbt while it is officially supported. During that period, it will remain available in dbt Cloud, and in the version dropdown on this website. While we do not expect users to immediately upgrade to newer minor versions as soon as they're available, there will always be some features and fixes that are only available for users of the latest minor version. | ||
During the official support window period, minor versions will remain available in dbt Cloud, and in the version dropdown on the docs site. While we do not expect users to immediately upgrade to newer minor versions as soon as they're available, there will always be some features and fixes that are only available for users of the latest minor version. | ||
matthewshaver marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Trying prereleases | ||
|
||
|
@@ -68,7 +62,7 @@ All dbt Core versions are available as _prereleases_ before the final release. " | |
|
||
Like many software projects, dbt Core releases follow [semantic versioning](https://semver.org/), which defines three types of version releases. | ||
|
||
- **Major versions:** To date, dbt Core has had one major version release: v1.0.0. When v2.0.0 is released, it will introduce new features and break backwards compatibility for functionality that has been deprecated. | ||
- **Major versions:** To date, dbt Core has had one major version release: v1.0.0. When v2.0.0 is released, it will introduce new features and backwards compatibility for functionality that has been deprecated will no longer work. | ||
matthewshaver marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **Minor versions**, also called "feature" releases, include a mix of new features, behind-the-scenes improvements, and changes to existing capabilities that are **backwards compatible** with previous minor versions. They will not break code in your project that relies on documented functionality. | ||
- **Patch versions**, also called "bugfix" or "security" releases, include **fixes _only_**. These fixes could be needed to restore previous (documented) behavior, fix obvious shortcomings of new features, or offer critical fixes for security or installation issues. We are judicious about which fixes are included in patch releases, to minimize the surface area of changes. | ||
|
||
|
@@ -78,21 +72,21 @@ We are committed to avoiding breaking changes in minor versions for end users of | |
|
||
### How we version adapter plugins | ||
|
||
When you use dbt, you're using `dbt-core` together with an adapter plugin specific to your database. You can see the current list in [Supported Data Platforms](supported-data-platforms). Both `dbt-core` and dbt adapter plugins follow semantic versioning. | ||
When you use dbt, you use a combination of `dbt-core` and an adapter plugin specific to your database. You can see the current list in [Supported Data Platforms](supported-data-platforms). Both `dbt-core` and dbt adapter plugins follow semantic versioning. | ||
|
||
`dbt-core` and adapter plugins coordinate new features and behind-the-scenes changes in minor releases. When it comes to fixing bugs, sooner is better—so patch versions are released independently for `dbt-core` and plugins. | ||
`dbt-core` and adapter plugins coordinate new features and behind-the-scenes changes in minor releases. When fixing bugs, sooner is better, so patch versions are released independently for `dbt-core` and plugins. | ||
|
||
What does that mean? Patch version numbers are likely to be different between `dbt-core` and the adapter plugin(s) you have installed. Major and minor version numbers should always match. | ||
That means that patch version numbers will likely differ between `dbt-core` and the adapter plugin(s) you have installed. However, major and minor version numbers should always match. | ||
|
||
As an example, on March 1, you may find you're using `dbt-core==1.0.3` with `dbt-snowflake==1.0.0`. The most important thing is that you're using the latest patch available for each (v1.0.x). If you're running dbt locally, you can use the `dbt --version` command to see which versions you have installed: | ||
For example, you may find you're using `dbt-core==1.2.3` with `dbt-snowflake==1.2.0`. It is critical that you're using the latest patch available for both core and the adapter (v1.2.x). Use the `dbt --version` command to see which versions you have installed: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good point. How should we keep these numbers up-to-date? :) I guess we could add to the release checklist for new minor versions There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will add it to the list! |
||
``` | ||
$ dbt --version | ||
installed version: 1.0.3 | ||
latest version: 1.0.3 | ||
installed version: 1.2.3 | ||
latest version: 1.2.3 | ||
|
||
Up to date! | ||
|
||
Plugins: | ||
- snowflake: 1.0.0 - Up to date! | ||
- snowflake: 1.2.0 - Up to date! | ||
``` | ||
It's likely that newer patches have become available since then, so it's always important to check and make sure you're up to date! |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,11 +27,3 @@ $ dbt test --select source:jaffle_shop.orders | |
``` | ||
|
||
Yep, we know this syntax is a little less than ideal, so we're hoping to improve it in a future release. Check out the [model selection syntax](node-selection/syntax) for more examples! | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
We've had this syntax for some time, people don't seem to hate it too much :) let's remove this line
matthewshaver marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
:::info Node selection syntax | ||
In dbt 0.21.0, the node selection syntax [was standardized](https://github.com/dbt-labs/dbt-core/pull/3791) to use `--select` everywhere. Before this, some commands like `dbt run` and `dbt test` used `--models` instead. | ||
|
||
Older versions still show an error because [argparse](https://docs.python.org/3/library/argparse.html#allow-abbrev) is expanding `--select` to `--selector`, which is a different flag. | ||
To fix this issue, either upgrade to dbt 0.21.0 or higher, or use `--models` instead of `--select`. | ||
::: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Given that the purpose of this
.md
file is to show how to use version blocks, should we leave these in place, and just bump up the numbers? Or are there enough other examples that we should just remove entirely?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going to leave these as I think I just got carried away. Will instead update the sample version number we used