Create method for env var deprecation #7046
Closed
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
stu-k
commented
Feb 24, 2023
core/dbt/events/types.py
Outdated
Comment on lines
402
to
407
| description = ( | ||
| f"The environment variable `{self.old_name}` has been renamed to `{self.new_name}`. " | ||
| f"Since `{self.old_name}` has been set, its value will be used instead of `{self.new_name}`." | ||
| ) |
There was a problem hiding this comment.
This message is lacking. @dbeatty10 Do you have a suggestion for a better message to communicate that
ENV_VAR_FOOhas been deprecated in favor ofENV_VAR_BAR- If you set
ENV_VAR_FOOits will be used instead of the value ofENV_VAR_BAR
There was a problem hiding this comment.
What do you think of this?
The environment variable `ENV_VAR_FOO` has been deprecated and renamed as `ENV_VAR_BAR`.
If `ENV_VAR_FOO` is currently set, its value will be used instead of `ENV_VAR_BAR`.
Set `ENV_VAR_BAR` and unset `ENV_VAR_FOO` to avoid this deprecation warning and ensure it works properly in a future release.It's kinda wordy, but it communicates three key things:
- The name you are using is deprecated and it has a new name.
- Here's how it will behave in the meantime.
- Here's the action you should take.
MichelleArk
reviewed
Feb 24, 2023
stu-k
force-pushed
the
CT-2109/flag-param-renaming
branch
from
bdbdea0 to
7ceb9bc
Compare
stu-k
force-pushed
the
CT-2109/flag-param-renaming
branch
from
7ceb9bc to
42ca93f
Compare
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.
resolves #6960
Description
Added a method of warning about deprecated environment variables and implemented it for
DBT_NO_PRINT -> DBT_PRINT.Checklist
changie newto create a changelog entry