[RFC] Deprecation of module variables and outputs #2180
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
Signed-off-by: ollevche <[email protected]>
|
Reminder for the PR assignee: If this is a user-visible change, please update the changelog as part of the PR. |
Comment on lines
+95
to
+105
| Right now, OpenTofu doesn't treat comments as something with a special meaning so this feature would introduce a whole new set | ||
| of functionality to be used across the OpenTofu. It would require a separate RFC to define how this notion could potentially | ||
| evolve. | ||
|
|
||
| ```hcl | ||
| # @deprecated: This variable will be removed on 2024-12-31. Use that_is_my_variable instead. | ||
| variable "this_is_my_variable" { | ||
| type = string | ||
| description = "This is a variable for the old way of configuring things." | ||
| } | ||
| ``` |
There was a problem hiding this comment.
I believe this to be a terrible idea, but it may just be having too much exposure to PHP in the past. Comment parsing is always a but tricky and I'm not even sure it's feasible. (Does HCL retain comments after parsing?)
|
|
||
| ### Open Questions | ||
|
|
||
| * Do we want to support silencing of deprecation warnings? |
There was a problem hiding this comment.
I believe we should support silencing transient dependencies. This could be done as part of the module{} block, or we can add it as a tofu-wide option.
Signed-off-by: ollevche <[email protected]>
Signed-off-by: ollevche <[email protected]>
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.
Part of #1005.
In this PR I summarized the discussion around variables and outputs deprecation; provided answers to some of the questions that popped up; and described how to approach this feature technically.
Rendered version.
Target Release
Not applicable
Checklist