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

Model property deprecation_date #3579

Merged
merged 9 commits into from
Jul 5, 2023
Merged

Model property deprecation_date #3579

merged 9 commits into from
Jul 5, 2023

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Jun 20, 2023

What are you changing in this pull request and why?

Adding new model property deprecation_date
Create new model property card
Add to existing table of properties

Checklist

Uncomment if you're publishing docs for a prerelease version of dbt (delete if not applicable):

  • Add versioning components, as described in Versioning Docs
  • [TODO] Add a note to the prerelease version Migration Guide
  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

Link to Core repo PR

dbt-labs/dbt-core#7562

@matthewshaver matthewshaver requested a review from a team as a code owner June 20, 2023 14:36
@netlify
Copy link

netlify bot commented Jun 20, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit ddb5b02
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64a594c5e4597f000832794a
😎 Deploy Preview https://deploy-preview-3579--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: small This change will take 1 to 2 days to address labels Jun 20, 2023
@matthewshaver matthewshaver linked an issue Jun 20, 2023 that may be closed by this pull request
1 task
Copy link
Contributor

@dbeatty10 dbeatty10 left a comment

Choose a reason for hiding this comment

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

This is looking good!

I added inline suggestions for using a full "aware" datetime rather than just a "naive" date.

See below for two more suggestions.

1. Model governance

It seems like we should update https://docs.getdbt.com/docs/collaborate/govern/model-versions to add a section and examples for deprecation_date.

2. Supported formats

I haven't tried any of these formats yet, but I'd hope / expect that they all work:

canonical: 2001-12-15T02:59:43.1Z
iso8601: 2001-12-14t21:59:43.10-05:00
spaced: 2001-12-14 21:59:43.10 -5
date: 2002-12-14

In particular, I'm hoping that all RFC 3339 timestamp formats are supported (as well as the most common ISO 8601 formats).

See here for examples of different formats:
https://dbeatty10.github.io/rfc3339-iso8601/

models:
- name: my_model
description: deprecating in the future
deprecation_date: 2999-01-01
Copy link
Contributor

Choose a reason for hiding this comment

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

See datetime format comment above.

@jtcohen6
Copy link
Collaborator

Agree with Doug -- we should add a new section to the docs on "Model Versions" about deprecation_date, and also update anywhere where we've said "in the future":

In the future, dbt will also offer first-class support for deprecating models (dbt-core#7433).

dbt will notify consumers of your versioned model when new versions become available, or (in the future) when they are slated for deprecation

Because dbt knows that these models are actually the same model, it can notify downstream consumers as new versions become available, and (in the future) as older versions are slated for deprecation.

Co-authored-by: Doug Beatty <44704949+dbeatty10@users.noreply.github.com>
@matthewshaver matthewshaver changed the title [DRAFT] Model property deprecation_date Model property deprecation_date Jul 5, 2023
@@ -31,6 +31,10 @@ exports.versions = [
]

exports.versionedPages = [
{
Copy link
Contributor

Choose a reason for hiding this comment

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

trying to fix deploy preview build error

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.

fixed the deploy error and the preview looks fine. two questions, i wanted to flag is:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs 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.

deprecation_date for model versions
4 participants