Skip to content

Commit

Permalink
Model property deprecation_date (#3579)
Browse files Browse the repository at this point in the history
## 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):
- [x] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [TODO] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/guides/migration/versions)
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] 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):
- [x] Add page to `website/sidebars.js`
- [x] Provide a unique filename for the new page

Link to Core repo PR

dbt-labs/dbt-core#7562
  • Loading branch information
matthewshaver authored Jul 5, 2023
2 parents 7601780 + ddb5b02 commit 7f34cb1
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
4 changes: 4 additions & 0 deletions website/dbt-versions.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ exports.versions = [
]

exports.versionedPages = [
{
"page": "reference/resource-properties/deprecation_date",
"firstVersion": "1.6",
},
{
"page": "reference/commands/retry",
"firstVersion": "1.6",
Expand Down
1 change: 1 addition & 0 deletions website/docs/reference/model-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ models:
[docs](/reference/resource-configs/docs):
show: true | false
[latest_version](/reference/resource-properties/latest_version): <version_identifier>
[deprecation_date](/reference/resource-properties/deprecation_date): <YAML_DateTime>
[access](/reference/resource-properties/access): private | protected | public
[config](/reference/resource-properties/config):
[<model_config>](/reference/model-configs): <config_value>
Expand Down
32 changes: 32 additions & 0 deletions website/docs/reference/resource-properties/deprecation_date.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
resource_types: [models]
datatype: deprecation_date
required: no
---

<File name='models/<schema>.yml'>

```yml
models:
- name: my_model
description: deprecated
deprecation_date: 1999-01-01 00:00:00.00+00:00
```
</File>
<File name='models/<schema>.yml'>
```yml
version: 2
models:
- name: my_model
description: deprecating in the future
deprecation_date: 2999-01-01 00:00:00.00+00:00
```
</File>
## Definition
The deprecation date of the model in YAML DateTime format.
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,7 @@ const sidebarSettings = {
"reference/resource-properties/columns",
"reference/resource-properties/config",
"reference/resource-properties/constraints",
"reference/resource-properties/deprecation_date",
"reference/resource-properties/description",
"reference/resource-properties/latest_version",
"reference/resource-properties/include-exclude",
Expand Down

0 comments on commit 7f34cb1

Please sign in to comment.