From 0319c2e9451d37e01fb369cddad9584232220730 Mon Sep 17 00:00:00 2001 From: Natalie Fiann Date: Mon, 23 Sep 2024 15:22:36 +0100 Subject: [PATCH 1/9] Updated breaking changes section --- .../docs/docs/collaborate/govern/model-contracts.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index e186609b746..700cbab972e 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -206,9 +206,13 @@ At the same time, for models with many columns, we understand that this can mean When comparing to a previous project state, dbt will look for breaking changes that could impact downstream consumers. If breaking changes are detected, dbt will present a contract error. Breaking changes include: -- Removing an existing column -- Changing the `data_type` of an existing column -- Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher) +- Removing an existing column. +- Changing the `data_type` of an existing column. +- Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). +- Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled (by config: enabled): + - if the model is versioned, dbt will throw an error. + - if the model is unversioned, dbt will raise a warning. + More details are available in the [contract reference](/reference/resource-configs/contract#detecting-breaking-changes). From 6f1491e8b1ea91ff877540caefc067a82a325c3b Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:31:44 +0100 Subject: [PATCH 2/9] Update website/docs/docs/collaborate/govern/model-contracts.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/collaborate/govern/model-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index 700cbab972e..137766fb51b 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -209,7 +209,7 @@ Breaking changes include: - Removing an existing column. - Changing the `data_type` of an existing column. - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). -- Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled (by config: enabled): +- Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - if the model is versioned, dbt will throw an error. - if the model is unversioned, dbt will raise a warning. From bf3820fdf1208eb12f886b94dedb557e5e753ae4 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:32:02 +0100 Subject: [PATCH 3/9] Update website/docs/docs/collaborate/govern/model-contracts.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/collaborate/govern/model-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index 137766fb51b..611c70696e3 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -210,7 +210,7 @@ Breaking changes include: - Changing the `data_type` of an existing column. - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). - Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - - if the model is versioned, dbt will throw an error. + - If the model is versioned, dbt will throw an error. - if the model is unversioned, dbt will raise a warning. From ce00bc4bcf09816f7e888225acd57afad3b10b46 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 23 Sep 2024 16:32:10 +0100 Subject: [PATCH 4/9] Update website/docs/docs/collaborate/govern/model-contracts.md Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com> --- website/docs/docs/collaborate/govern/model-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index 611c70696e3..4e9066a4e7f 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -211,7 +211,7 @@ Breaking changes include: - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). - Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - If the model is versioned, dbt will throw an error. - - if the model is unversioned, dbt will raise a warning. + - If the model is unversioned, dbt will raise a warning. More details are available in the [contract reference](/reference/resource-configs/contract#detecting-breaking-changes). From ab9b242f04e08d911053da65ac49d55f2e04bf98 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Tue, 24 Sep 2024 10:17:25 +0100 Subject: [PATCH 5/9] Update website/docs/docs/collaborate/govern/model-contracts.md Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com> --- website/docs/docs/collaborate/govern/model-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index 4e9066a4e7f..6f3d16d3d85 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -210,7 +210,7 @@ Breaking changes include: - Changing the `data_type` of an existing column. - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). - Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - - If the model is versioned, dbt will throw an error. + - When you remove a versioned model, you will receive an error. - If the model is unversioned, dbt will raise a warning. From 1a85851e4bdea7cd3e6ad2b4adf9c066d8603928 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Tue, 24 Sep 2024 10:17:42 +0100 Subject: [PATCH 6/9] Update website/docs/docs/collaborate/govern/model-contracts.md Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com> --- website/docs/docs/collaborate/govern/model-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index 6f3d16d3d85..ca340953aed 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -211,7 +211,7 @@ Breaking changes include: - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). - Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - When you remove a versioned model, you will receive an error. - - If the model is unversioned, dbt will raise a warning. + - When you remove an unversioned contract, you will receive a warning. More details are available in the [contract reference](/reference/resource-configs/contract#detecting-breaking-changes). From 6e723e1fff6f5e934d985b4ccbc775ab931f99f3 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 30 Sep 2024 11:58:10 +0100 Subject: [PATCH 7/9] Update website/docs/docs/collaborate/govern/model-contracts.md --- website/docs/docs/collaborate/govern/model-contracts.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index ca340953aed..a8883579129 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -209,6 +209,9 @@ Breaking changes include: - Removing an existing column. - Changing the `data_type` of an existing column. - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). + + + - Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - When you remove a versioned model, you will receive an error. - When you remove an unversioned contract, you will receive a warning. From 5a8c8487d2d32da99c396f6e6f8129749c270641 Mon Sep 17 00:00:00 2001 From: nataliefiann <120089939+nataliefiann@users.noreply.github.com> Date: Mon, 30 Sep 2024 11:59:13 +0100 Subject: [PATCH 8/9] Update website/docs/docs/collaborate/govern/model-contracts.md --- website/docs/docs/collaborate/govern/model-contracts.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index a8883579129..f3605002aca 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -215,7 +215,7 @@ Breaking changes include: - Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - When you remove a versioned model, you will receive an error. - When you remove an unversioned contract, you will receive a warning. - + More details are available in the [contract reference](/reference/resource-configs/contract#detecting-breaking-changes). From fe77ab4a61be435985c4cfb3c2275982165207a1 Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Tue, 1 Oct 2024 12:37:40 -0600 Subject: [PATCH 9/9] Align with pre-existing style --- .../docs/docs/collaborate/govern/model-contracts.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/website/docs/docs/collaborate/govern/model-contracts.md b/website/docs/docs/collaborate/govern/model-contracts.md index f3605002aca..b07ce909480 100644 --- a/website/docs/docs/collaborate/govern/model-contracts.md +++ b/website/docs/docs/collaborate/govern/model-contracts.md @@ -209,13 +209,9 @@ Breaking changes include: - Removing an existing column. - Changing the `data_type` of an existing column. - Removing or modifying one of the `constraints` on an existing column (dbt v1.6 or higher). - - - -- Removing a contracted model constitutes a breaking change. A model is considered 'removed' if it is deleted, renamed, or disabled: - - When you remove a versioned model, you will receive an error. - - When you remove an unversioned contract, you will receive a warning. - +- Removing a contracted model by deleting, renaming, or disabling it (dbt v1.9 or higher). + - versioned models will raise an error. + - unversioned models will raise a warning. More details are available in the [contract reference](/reference/resource-configs/contract#detecting-breaking-changes).