Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update model-notifications #6556

Merged
merged 7 commits into from
Nov 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 40 additions & 6 deletions website/docs/docs/deploy/model-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,9 @@ Create configuration YAML files in your project for dbt to send notifications ab

## Configure groups

Add your group configuration in either the `dbt_project.yml` or `groups.yml` file. For example:
Define your groups in any .yml file in your [models directory](/reference/project-configs/model-paths). For example:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong and is the main thing I wanted to do in the PR


<File name='models/groups.yml'>

```yml
version: 2
Expand All @@ -42,22 +44,26 @@ groups:
- name: finance
description: "Models related to the finance department"
owner:
# 'name' or 'email' is required
# Email is required to receive model-level notifications, additional properties are also allowed.
name: "Finance Team"
email: [email protected]
slack: finance-data
favorite_food: donuts

- name: marketing
description: "Models related to the marketing department"
owner:
name: "Marketing Team"
email: [email protected]
slack: marketing-data
favorite_food: jaffles
Comment on lines +47 to +57
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for clarity and is optional, but reduces the likelihood people misbelieve that Slack notifs are supported

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good callout! i assumed slack was supported when reading

```

## Set up models
</File>

## Attach groups to models

Set up your model configuration in either the `dbt_project.yml` or `groups.yml` file; doing this automatically sets up notifications for tests, too. For example:
Attach groups to models as you would any other config, in either the `dbt_project.yml` or `whatever.yml` files. For example:

<File name='models/marts.yml'>

```yml
version: 2
Expand All @@ -74,6 +80,34 @@ models:
group: marketing

```
</File>

By assigning groups in the `dbt_project.yml` file, you can capture all models in a subdirectory at once.

In this example, model notifications related to staging models go to the data engineering group, `marts/sales` models to the finance team, and `marts/campaigns` models to the marketing team.

<File name='dbt_project.yml'>

```yml
config-version: 2
name: "jaffle_shop"

[...]

models:
jaffle_shop:
staging:
+group: data_engineering
marts:
sales:
+group: finance
campaigns:
+group: marketing

```

</File>
Attaching a group to a model also encompasses its tests, so you will also receive notifications for a model's test failures.

## Enable access to model notifications

Expand Down
Loading