-
Notifications
You must be signed in to change notification settings - Fork 26
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.
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
Revise rules documentation #158
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -279,8 +279,8 @@ Reference: https://github.com/terraform-linters/tflint-ruleset-terraform/blob/v0 | |
|
||
## Why | ||
|
||
Naming conventions are optional, so it is not necessary to follow this. | ||
But this rule is useful if you want to force the following naming conventions in line with the [Terraform Plugin Naming Best Practices](https://www.terraform.io/docs/extend/best-practices/naming.html). | ||
Naming conventions are optional, so you don't necessarily have to follow them. | ||
However, if your team owns Terraform configurations, it can be helpful to have a consistent naming convention. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The linked documentation doesn't specifically mention naming conventions for label names, so deleted it. |
||
|
||
## How To Fix | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,8 @@ | |
|
||
Check that all `required_providers` are used in the module. | ||
|
||
Note: Because TFLint cannot traverse the complete module tree, it may issue warnings for `required_providers` declared to specify constraints on the provider versions used by a module. If this false positive is unacceptable, you can disable the rule. See also https://github.com/terraform-linters/tflint-ruleset-terraform/issues/21. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It mentions the technical limitations that pose a problem in enabling this rule. |
||
|
||
## Configuration | ||
|
||
```hcl | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The deprecation warning ended up not being an error and was removed in v0.15 hashicorp/terraform#27835