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

Jump to bottom

[Flags] Rename behavior change flags + add consistent deprecation warnings #10062

Closed
2 of 6 tasks
jtcohen6 opened this issue Apr 29, 2024 · 1 comment · Fixed by #10063
Closed
2 of 6 tasks

[Flags] Rename behavior change flags + add consistent deprecation warnings #10062

jtcohen6 opened this issue Apr 29, 2024 · 1 comment · Fixed by #10063
Assignees
@jtcohen6
Labels
behavior_change_flag flags user docs [docs.getdbt.com] Needs better documentation
Milestone
v1.8

Comments

@jtcohen6
Copy link
Contributor

Housekeeping

  • I am a maintainer of dbt-core

Short description

Bring behavior change flags into compliance with proposed guidance

Internal Notion, will turn into README for this repo

Acceptance criteria

We’ve implemented three flags thus far. Here’s what we need to do to get ourselves into compliance with the current proposal:

  1. require_explicit_package_overrides_for_builtin_materializations
    • Backport flag + fix + deprecation warning to v1.6.x + v1.7.x
    • Flip default from False to True for v1.8.0rc1
  2. require_resource_names_without_spaces
    • Rename from current name (allow_spaces_in_model_names) so that it matches the naming guidance (always False → True)
    • Reimplement deprecation warning to use deprecations module, so that telemetry is consistent.
      • Right now this is just two separate events that happen to have Deprecation in their name.
      • This may require different messages for Warn versus Error, instead of one DynamicLevel message.
  3. source_freshness_run_project_hooks
    • Add a deprecation warning, which should be raised in cases where:
      • (a) someone is running the source freshness command
      • (b) they have at least one project hook (on-run-*) defined

Suggested Tests

Update existing tests that we added in:

Impact to Other Teams

No impact

Will backports be required?

No backports

Context

No response
@jtcohen6 jtcohen6 added user docs [docs.getdbt.com] Needs better documentation flags labels Apr 29, 2024
@jtcohen6 jtcohen6 added this to the v1.8 milestone Apr 29, 2024
@jtcohen6 jtcohen6 self-assigned this Apr 29, 2024
This was referenced Apr 29, 2024
Merged
Merged
@FishtownBuildBot
Copy link
Collaborator

Opened a new issue in dbt-labs/docs.getdbt.com: dbt-labs/docs.getdbt.com#5420

runleonarun added a commit to dbt-labs/docs.getdbt.com that referenced this issue May 2, 2024
@jtcohen6 @mirnawong1 @runleonarun
Revise docs for behavior change flags (#5389)
d8f0ef2 
## What are you changing in this pull request and why?

**Legacy behaviors:**
- Update explanations
- Rename behavior change flags
- Add table with dates for Intro / Maturity

**v1.8 guide:**
- Reorganize + update with links to the legacy behavior page

**Depends on changes tracked here:**
- dbt-labs/dbt-core#10062

---------

Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jtcohen6 jtcohen6

Labels
behavior_change_flag flags user docs [docs.getdbt.com] Needs better documentation
Projects
None yet
Milestone
v1.8
Development

Successfully merging a pull request may close this issue.

Consistent behavior change flag names + deprecation warnings dbt-labs/dbt-core
3 participants
@MichelleArk @jtcohen6 @FishtownBuildBot