Skip to content

Commit b7b7507

Browse files
sdebruynclaude
andauthored
Add dbt-project-evaluator package docs page (#269)
Documents the package, dispatch config, project_vars (max_depth_dag), known dbt-utils dependency, and the integration_tests subdirectory caveat. Notes Lakehouse compatibility (integration-tested) and links to upstream PR dbt-labs/dbt-project-evaluator#576 for Fabric DW. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent bf45c64 commit b7b7507

3 files changed

Lines changed: 39 additions & 0 deletions

File tree

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# dbt-project-evaluator
2+
3+
**Tested version:** 1.2.4 | **Integration tested:** Yes (Lakehouse only)
4+
5+
[dbt-project-evaluator](https://github.com/dbt-labs/dbt-project-evaluator) audits your dbt project against best practices: model naming, documentation coverage, test coverage, DAG structure, modeling conventions, and more.
6+
7+
## Compute engine support
8+
9+
| Compute engine | Status |
10+
|---|---|
11+
| Lakehouse (FabricSpark) | :white_check_mark: Tested |
12+
| Data Warehouse (Fabric) | :x: Not compatible — upstream PR [dbt-labs/dbt-project-evaluator#576](https://github.com/dbt-labs/dbt-project-evaluator/pull/576) adds Fabric DW support |
13+
14+
## Dispatch configuration
15+
16+
```yaml
17+
dispatch:
18+
- macro_namespace: dbt_project_evaluator
19+
search_order: ['your_project_name', 'dbt', 'dbt_project_evaluator']
20+
- macro_namespace: dbt_utils
21+
search_order: ['your_project_name', 'dbt', 'dbt_utils']
22+
```
23+
24+
## Macro compatibility
25+
26+
All dbt-project-evaluator macros work on Lakehouse without adapter-specific overrides — the package's logic relies on dbt's graph context and standard SQL operations that Spark SQL handles natively.
27+
28+
## Notes
29+
30+
- Depends on [dbt-utils](dbt-utils.md). Include the dbt-utils dispatch configuration alongside the project-evaluator one.
31+
- If your project DAG depth exceeds the default, override `max_depth_dag` in your `dbt_project.yml` `vars`. The integration tests set it to `9`:
32+
33+
```yaml
34+
vars:
35+
max_depth_dag: 9
36+
```
37+
- The package's `integration_tests` subdirectory has an internal local dependency (`exclude_package/`) that cannot be resolved when installed as a git subdirectory package. This only affects running the package's own integration tests, not normal use of the package against your project.

docs/packages/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ The `dbt` entry in the search order tells dbt to check the adapter's built-in ma
6161
| [dbt-audit-helper](dbt-audit-helper.md) | 0.13.0 | :white_check_mark: Tested | :white_check_mark: Tested |
6262
| [dbt-external-tables](dbt-external-tables.md) | 0.11.0 | :white_check_mark: Tested | :x: Not applicable |
6363
| [dbt-profiler](dbt-profiler.md) | 1.0.0 | :white_check_mark: Tested | :white_check_mark: Tested |
64+
| [dbt-project-evaluator](dbt-project-evaluator.md) | 1.2.4 | :x: Not compatible ([upstream PR](https://github.com/dbt-labs/dbt-project-evaluator/pull/576)) | :white_check_mark: Tested |
6465

6566
"Tested" means the adapter runs automated integration tests for that package on the given compute engine. "Via dbt-spark" means the package works through inherited dbt-spark macros without adapter-specific overrides.
6667

zensical.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ nav = [
4949
{ "dbt-expectations" = "packages/dbt-expectations.md" },
5050
{ "dbt-external-tables" = "packages/dbt-external-tables.md" },
5151
{ "dbt-profiler" = "packages/dbt-profiler.md" },
52+
{ "dbt-project-evaluator" = "packages/dbt-project-evaluator.md" },
5253
{ "dbt-utils" = "packages/dbt-utils.md" },
5354
] },
5455

0 commit comments

Comments
 (0)