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.

Sign up for GitHub

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

Cleaning up legacy behavior section #5071

Merged
merged 1 commit into from
Mar 13, 2024
Merged

Cleaning up legacy behavior section #5071

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions website/docs/reference/global-configs/legacy-behaviors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,17 @@ These flags can _only_ be set in `dbt_project.yml`. They configure behaviors clo
## Behaviors

### `source_freshness_run_project_hooks`
- Should the 'dbt source freshness' command include [on-run-start / on-run-end hooks](/reference/project-configs/on-run-start-on-run-end)?
- Planned introduction in v1.8, with default 'True'
- Planned removal in v1.9

If you have specific project `on-run-start` / `on-run-end` hooks that should not run before/after `source freshness` command, you can add a conditional check to those hooks:
```yaml
# dbt_project.yml
If you have specific project [`on-run-start` / `on-run-end`](/reference/project-configs/on-run-start-on-run-end) hooks that should not run before/after `source freshness` command, you can add a conditional check to those hooks:

<File name='dbt_project.yml'>

```yaml
on-run-start:
- '{{ ... if flags.WHICH != 'freshness' }}'
```
</File>

You can configure the `dbt source freshness` command to include on-run-start / on-run-end hooks in v1.8 with a planned removal in v1.9. The default value is `True`.
Copy link
Contributor

Choose a reason for hiding this comment

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

i like adding 'dbt version' initially so it's super clear

Suggested change
You can configure the `dbt source freshness` command to include on-run-start / on-run-end hooks in v1.8 with a planned removal in v1.9. The default value is `True`.
You can configure the `dbt source freshness` command to include on-run-start / on-run-end hooks in dbt version 1.8 with a planned removal in dbt version 1.9. The default value is `True`.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We use this language throughout our docs. I think it's understood through historical context that v1.# refers to our dbt versions.


In the meantime, you can set `source_freshness_run_project_hooks: False` to preserve the legacy behavior.
Loading