Skip to content

Commit 20be4a5

Browse files
authored
Add notes about auto installation (#99)
1 parent 7d57a87 commit 20be4a5

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@ TFLint ruleset plugin for Terraform Google Cloud Platform provider
1212

1313
## Installation
1414

15-
Download the plugin and place it in `~/.tflint.d/plugins/tflint-ruleset-google` (or `./.tflint.d/plugins/tflint-ruleset-google`). When using the plugin, configure as follows in `.tflint.hcl`:
15+
You can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:
1616

1717
```hcl
1818
plugin "google" {
1919
enabled = true
20+
version = "0.9.0"
21+
source = "github.com/terraform-linters/tflint-ruleset-google"
2022
}
2123
```
2224

@@ -40,6 +42,14 @@ You can easily install the built plugin with the following:
4042
$ make install
4143
```
4244

45+
Note that if you install the plugin with `make install`, you must omit the `version` and `source` attributes in `.tflint.hcl`:
46+
47+
```hcl
48+
plugin "google" {
49+
enabled = true
50+
}
51+
```
52+
4353
## Add a new rule
4454

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

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Here's an example:
66

77
```hcl
88
plugin "google" {
9-
enabled = true
9+
// Plugin common attributes
1010
1111
deep_check = false
1212
}

0 commit comments

Comments
 (0)