Skip to content

Commit

Permalink
Merge pull request #222 from dbt-labs/fix/update_ci_commands_readme
Browse files Browse the repository at this point in the history
Update CI commands in README
  • Loading branch information
graciegoheen authored Oct 12, 2022
2 parents 258ac2a + bcb469a commit 43b6d84
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Currently, the following adapters are supported:
- PostgreSQL
- Redshift
- Snowflake
- DuckDB

## Using This Package

Expand Down Expand Up @@ -44,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

Expand Down Expand Up @@ -1053,20 +1059,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)
<img width="500" alt="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" src="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
Expand Down

0 comments on commit 43b6d84

Please sign in to comment.