Update model-notifications #6556
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
content
joellabes
commented
Nov 27, 2024
| @@ -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: | |||
There was a problem hiding this comment.
This is wrong and is the main thing I wanted to do in the PR
Comment on lines
+47
to
+57
| # 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 |
There was a problem hiding this comment.
This is for clarity and is optional, but reduces the likelihood people misbelieve that Slack notifs are supported
There was a problem hiding this comment.
good callout! i assumed slack was supported when reading
Comment on lines
60
to
66
| </File> | ||
|
|
||
| ## Attach groups to models | ||
|
|
||
| Attach groups to models as you would any other config, in either the `dbt_project.yml` or `<whatever>.yml` files. For example: | ||
|
|
||
| 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: | ||
| <File name='models/marts.yml'> |
There was a problem hiding this comment.
The rest of this is purely additive and you can rework as you see fit
There was a problem hiding this comment.
thanks for adding the files tag! 🙏
Comment on lines
83
to
108
| </File> | ||
|
|
||
| By assigning groups in the `dbt_project.yml` file, you can capture all models in a subdirectory at once. In the below example, all notifications related to staging models will go to the data engineering group, whereas models in `marts/sales` will be routed to the finance 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. |
mirnawong1
reviewed
Nov 27, 2024
mirnawong1
reviewed
Nov 27, 2024
mirnawong1
approved these changes
Nov 27, 2024
There was a problem hiding this comment.
looks great to me and thanks for adjusting this @joellabes , made some small tweaks for clarity and merging for you!
|
Check your created Crawler Check your created index on your Algolia Application |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What are you changing in this pull request and why?
dbt_project.yml.🚀 Deployment available! Here are the direct links to the updated files: