diff --git a/docs/packages/dbt-project-evaluator.md b/docs/packages/dbt-project-evaluator.md new file mode 100644 index 00000000..901d6d6d --- /dev/null +++ b/docs/packages/dbt-project-evaluator.md @@ -0,0 +1,37 @@ +# dbt-project-evaluator + +**Tested version:** 1.2.4 | **Integration tested:** Yes (Lakehouse only) + +[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. + +## Compute engine support + +| Compute engine | Status | +|---|---| +| Lakehouse (FabricSpark) | :white_check_mark: Tested | +| 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 | + +## Dispatch configuration + +```yaml +dispatch: + - macro_namespace: dbt_project_evaluator + search_order: ['your_project_name', 'dbt', 'dbt_project_evaluator'] + - macro_namespace: dbt_utils + search_order: ['your_project_name', 'dbt', 'dbt_utils'] +``` + +## Macro compatibility + +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. + +## Notes + +- Depends on [dbt-utils](dbt-utils.md). Include the dbt-utils dispatch configuration alongside the project-evaluator one. +- 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`: + + ```yaml + vars: + max_depth_dag: 9 + ``` +- 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. diff --git a/docs/packages/index.md b/docs/packages/index.md index 724c12f2..8f9e00ff 100644 --- a/docs/packages/index.md +++ b/docs/packages/index.md @@ -61,6 +61,7 @@ The `dbt` entry in the search order tells dbt to check the adapter's built-in ma | [dbt-audit-helper](dbt-audit-helper.md) | 0.13.0 | :white_check_mark: Tested | :white_check_mark: Tested | | [dbt-external-tables](dbt-external-tables.md) | 0.11.0 | :white_check_mark: Tested | :x: Not applicable | | [dbt-profiler](dbt-profiler.md) | 1.0.0 | :white_check_mark: Tested | :white_check_mark: Tested | +| [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 | "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. diff --git a/zensical.toml b/zensical.toml index 3e90d0a8..ec7f278f 100644 --- a/zensical.toml +++ b/zensical.toml @@ -49,6 +49,7 @@ nav = [ { "dbt-expectations" = "packages/dbt-expectations.md" }, { "dbt-external-tables" = "packages/dbt-external-tables.md" }, { "dbt-profiler" = "packages/dbt-profiler.md" }, + { "dbt-project-evaluator" = "packages/dbt-project-evaluator.md" }, { "dbt-utils" = "packages/dbt-utils.md" }, ] },