Skip to content

terraform-linters/tflint-ruleset-google

Repository files navigation

TFLint Ruleset for terraform-provider-google

Build Status GitHub release License: MPL 2.0

TFLint ruleset plugin for Terraform Google Cloud Platform provider

Requirements

  • TFLint v0.42+
  • Go v1.22

Installation

You can install the plugin by adding a config to .tflint.hcl and running tflint --init:

plugin "google" {
    enabled = true
    version = "0.30.0"
    source  = "github.com/terraform-linters/tflint-ruleset-google"
}

For more configuration about the plugin, see Plugin Configuration.

Rules

100+ rules are available. See the documentation.

Building the plugin

Clone the repository locally and run the following command:

$ make

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:

plugin "google" {
    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:

$ go run ./rules/generator

Follow the instructions to edit the generated files and open a new pull request.