From 6f97d6bf7a79fd868205031165b9ea41599ec4c4 Mon Sep 17 00:00:00 2001 From: Grace Goheen Date: Wed, 5 Oct 2022 10:35:19 -0400 Subject: [PATCH 1/5] Update CI commands in README --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 5276143a..ad61d1f7 100644 --- a/README.md +++ b/README.md @@ -1053,20 +1053,24 @@ models: ### 2. Run this package for each pull request -Now, you can run this package as a step of your CI job/pipeline. In dbt Cloud, for example, you could simply add this command to your CI job: +Now, you can run this package as a step of your CI job/pipeline. In dbt Cloud, for example, you could update the commands of your CI job to: + ``` +dbt build --select state:modified+ --exclude package:dbt_project_evaluator dbt build --select package:dbt_project_evaluator ``` -Or, if you've [configured any exceptions](#configuring-exceptions-to-the-rules), this command: + +Or, if you've [configured any exceptions](#configuring-exceptions-to-the-rules), to: + ``` +dbt build --select state:modified+ --exclude package:dbt_project_evaluator dbt build --select package:dbt_project_evaluator dbt_project_evaluator_exceptions ``` -![Add command dbt build --select package:dbt_project_evaluator to CI job in dbt Cloud](https://user-images.githubusercontent.com/53586774/190683931-5010349f-0adc-454c-bf34-66e4bf9ef2f8.png) +![Add commands dbt build --select state:modified+ --exclude package:dbt_project_evaluator && dbt build --select package:dbt_project_evaluator dbt_project_evaluator_exceptions to CI job in dbt Cloud](https://user-images.githubusercontent.com/53586774/194086949-281cec1b-e6bf-4df2-a63f-302dc3bc4ba6.png) Note: ensure you have properly set up your dbt Cloud CI job using deferral and a webhook trigger by following [this documentation](https://docs.getdbt.com/docs/dbt-cloud/using-dbt-cloud/cloud-enabling-continuous-integration). - ---- ## Querying the DAG with SQL From a365e268d10281fb08b14d824c5effcb6757f7f9 Mon Sep 17 00:00:00 2001 From: Grace Goheen Date: Wed, 5 Oct 2022 10:39:34 -0400 Subject: [PATCH 2/5] Fixed size of image --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ad61d1f7..978784ca 100644 --- a/README.md +++ b/README.md @@ -1029,11 +1029,12 @@ Once you have addressed all current misalignments in your project (either by fix By default the tests in this package are configured with "warn" severity, we can override that for our CI jobs with an environment variable: 1. Create an environment variable to define the appropriate severity for each environment. In dbt Cloud, for example, we can easily create an environment variable `DBT_PROJECT_EVALUATOR_SEVERITY` that is set to "error" for the Continuous Integration environment and "warn" for all other environments: + ![Creating DBT_PROJECT_EVALUATOR_SEVERITY environment variable in dbt Cloud](https://user-images.githubusercontent.com/53586774/190683057-cf38d8dd-de70-457c-b65b-3532dc8f5ea1.png) Note: It is also possible to use an environment variable for dbt Core, but the actual implementation will depend on how dbt is orchestrated. -2. Update you project.yml file to override the default severity for all tests in this package: +1. Update you project.yml file to override the default severity for all tests in this package: ```yml # dbt_project.yml @@ -1067,7 +1068,7 @@ dbt build --select state:modified+ --exclude package:dbt_project_evaluator dbt build --select package:dbt_project_evaluator dbt_project_evaluator_exceptions ``` -![Add commands dbt build --select state:modified+ --exclude package:dbt_project_evaluator && dbt build --select package:dbt_project_evaluator dbt_project_evaluator_exceptions to CI job in dbt Cloud](https://user-images.githubusercontent.com/53586774/194086949-281cec1b-e6bf-4df2-a63f-302dc3bc4ba6.png) +Add commands dbt build --select state:modified+ --exclude package:dbt_project_evaluator && dbt build --select package:dbt_project_evaluator dbt_project_evaluator_exceptions to CI job in dbt Cloud Note: ensure you have properly set up your dbt Cloud CI job using deferral and a webhook trigger by following [this documentation](https://docs.getdbt.com/docs/dbt-cloud/using-dbt-cloud/cloud-enabling-continuous-integration). From 5bae75a5c0cffd3e729825ee029318c6cd50440f Mon Sep 17 00:00:00 2001 From: Grace Goheen Date: Wed, 5 Oct 2022 10:41:36 -0400 Subject: [PATCH 3/5] Fixed spacing --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 978784ca..b83d6d91 100644 --- a/README.md +++ b/README.md @@ -1029,12 +1029,11 @@ Once you have addressed all current misalignments in your project (either by fix By default the tests in this package are configured with "warn" severity, we can override that for our CI jobs with an environment variable: 1. Create an environment variable to define the appropriate severity for each environment. In dbt Cloud, for example, we can easily create an environment variable `DBT_PROJECT_EVALUATOR_SEVERITY` that is set to "error" for the Continuous Integration environment and "warn" for all other environments: - ![Creating DBT_PROJECT_EVALUATOR_SEVERITY environment variable in dbt Cloud](https://user-images.githubusercontent.com/53586774/190683057-cf38d8dd-de70-457c-b65b-3532dc8f5ea1.png) Note: It is also possible to use an environment variable for dbt Core, but the actual implementation will depend on how dbt is orchestrated. -1. Update you project.yml file to override the default severity for all tests in this package: +2. Update you project.yml file to override the default severity for all tests in this package: ```yml # dbt_project.yml From 60077f8884f04ced5d0767b886179c1975e0f1e2 Mon Sep 17 00:00:00 2001 From: Grace Goheen Date: Fri, 7 Oct 2022 14:47:23 -0400 Subject: [PATCH 4/5] update readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index b83d6d91..3aede408 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ Currently, the following adapters are supported: - PostgreSQL - Redshift - Snowflake +- DuckDB ## Using This Package From bcb469a96e8dbcb4f01f7c3ba58ba0d9bebda50b Mon Sep 17 00:00:00 2001 From: Grace Goheen Date: Wed, 12 Oct 2022 13:44:52 -0400 Subject: [PATCH 5/5] added additional instructions to readme How it Works --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 3aede408..c6924a8a 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,11 @@ This package will: Once you've installed the package, all you have to do is run a `dbt build --select package:dbt_project_evaluator`! +Each test warning indicates the presence of a type of misalignment. To troubleshoot a misalignment: +1. Locate the related documentation below +2. Query the associated model to find the specific instances of the issue within your project +3. Either fix the issue(s) or [customize](#customization) the package to exclude them + ---- ## Package Documentation