Skip to content

Commit c6e2bce

Browse files
authored
Add notes about auto installation (terraform-linters#123)
1 parent bb27ad4 commit c6e2bce

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,13 @@ This ruleset focus on possible errors and best practices about AWS resources. Ma
1414

1515
## Installation
1616

17-
Download the plugin and place it in `~/.tflint.d/plugins/tflint-ruleset-aws` (or `./.tflint.d/plugins/tflint-ruleset-aws`). You can also set another plugin location with the `TFLINT_PLUGIN_DIR` environment variable. When using the plugin, configure as follows in `.tflint.hcl`:
17+
You can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:
1818

1919
```hcl
2020
plugin "aws" {
2121
enabled = true
22+
version = "0.4.1"
23+
source = "github.com/terraform-linters/tflint-ruleset-aws"
2224
}
2325
```
2426

@@ -63,6 +65,14 @@ You can easily install the built plugin with the following:
6365
$ make install
6466
```
6567

68+
Note that if you install the plugin with `make install`, you must omit the `version` and `source` attributes in` .tflint.hcl`:
69+
70+
```hcl
71+
plugin "aws" {
72+
enabled = true
73+
}
74+
```
75+
6676
## Add a new rule
6777

6878
If you are interested in adding a new rule to this ruleset, you can use the generator. Run the following command:

docs/configuration.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Here's an example:
66

77
```hcl
88
plugin "aws" {
9-
enabled = true
9+
// Plugin common attributes
1010
1111
deep_check = false
1212
access_key = "AWS_ACCESS_KEY_ID"
@@ -17,12 +17,6 @@ plugin "aws" {
1717
}
1818
```
1919

20-
## `enabled`
21-
22-
Default: false
23-
24-
Enable this plugin. This is the common option in all plugins.
25-
2620
## `deep_check`
2721

2822
Default: false

0 commit comments

Comments
 (0)