Skip to content

Add notes about auto installation #123

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 5, 2021
Merged

Add notes about auto installation #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,13 @@ This ruleset focus on possible errors and best practices about AWS resources. Ma

## Installation

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`:
You can install the plugin by adding a config to `.tflint.hcl` and running `tflint --init`:

```hcl
plugin "aws" {
enabled = true
version = "0.4.1"
source = "github.com/terraform-linters/tflint-ruleset-aws"
}
```

Expand Down Expand Up @@ -63,6 +65,14 @@ You can easily install the built plugin with the following:
$ make install
```

Note that if you install the plugin with `make install`, you must omit the `version` and `source` attributes in` .tflint.hcl`:

```hcl
plugin "aws" {
enabled = true
}
```

## Add a new rule

If you are interested in adding a new rule to this ruleset, you can use the generator. Run the following command:
Expand Down
8 changes: 1 addition & 7 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Here's an example:

```hcl
plugin "aws" {
enabled = true
// Plugin common attributes

deep_check = false
access_key = "AWS_ACCESS_KEY_ID"
Expand All @@ -17,12 +17,6 @@ plugin "aws" {
}
```

## `enabled`

Default: false

Enable this plugin. This is the common option in all plugins.

## `deep_check`

Default: false
Expand Down