Merge branch 'main' into dependabot/pip/pydantic-2.9.1

godatadriven · Sep 9, 2024 · 3372684 · 3372684
2 parents c930968 + 2d2f164
commit 3372684
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 2 deletions.
diff --git a/.github/workflows/post_release_pipeline.yml b/.github/workflows/post_release_pipeline.yml
@@ -104,7 +104,9 @@ jobs:
 
             - name: Install `dbt-bouncer`
               if: matrix.operating-system == 'windows-latest'
-              run: pip install dbt-bouncer=='("${{ github.ref }}" -Split "/")[2]'
+              run: |
+                $env:DBT_BOUNCER_VERSION = $("${{ github.ref }}" -Split "/")[2].TrimStart("v")
+                pip install "dbt-bouncer==$env:DBT_BOUNCER_VERSION"
 
             - name: Install `dbt-bouncer`
               if: matrix.operating-system != 'windows-latest'

diff --git a/README.md b/README.md
@@ -54,6 +54,48 @@
 
 All documentation can be found on `dbt-bouncer` [documentation website](https://godatadriven.github.io/dbt-bouncer/).
 
+### TLDR
+
+1. Install `dbt-bouncer`:
+
+    ```shell
+    pip install dbt-bouncer
+    ```
+
+1. Create a `dbt-bouncer.yml` config file:
+
+    ```yml
+    manifest_checks:
+      - name: check_model_directories
+        include: ^models
+        permitted_sub_directories:
+          - intermediate
+          - marts
+          - staging
+      - name: check_model_names
+        include: ^models/staging
+        model_name_pattern: ^stg_
+    catalog_checks:
+      - name: check_columns_are_documented_in_public_models
+    run_results_checks:
+      - name: check_run_results_max_execution_time
+        max_execution_time_seconds: 60
+    ```
+
+1. Run `dbt-bouncer`:
+
+    ```
+    $ dbt-bouncer
+
+    [...]
+    Running checks... |################################| 20/20
+    Done. SUCCESS=19 WARN=0 ERROR=1
+    Failed checks:
+    | Check name               | Severity | Failure message                                                                       |
+    |--------------------------|----------|---------------------------------------------------------------------------------------|
+    | check_model_directories: | error    | AssertionError: `model` is located in `utilities`, this is not a valid sub-directory. |
+    ```
+
 ## Reporting bugs and contributing code
 
 - Want to report a bug or request a feature? Let us know and open [an issue](https://github.com/godatadriven/dbt-bouncer/issues/new/choose).

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -48,8 +48,8 @@ nav:
       - Unit Tests: checks/manifest/check_unit_tests.md
     - Run Results:
       - Run Results: checks/run_results/check_run_results.md
-  - FAQ: faq.md
   - CLI: cli.md
+  - FAQ: faq.md
   - Contributing: CONTRIBUTING.md
 
 plugins: