style(lint): added linting support

.github/workflows/ci.yaml

@@ -37,3 +37,10 @@ jobs:
 
  - name: Terraform Validate
  run: make validate
+
+ - uses: terraform-linters/setup-tflint@v4
+ with:
+ tflint_version: v0.49.0
+
+ - name: Lint
+ run: make lint

.tflint.hcl

@@ -0,0 +1,4 @@
+plugin "terraform" {
+ enabled = true
+ preset = "recommended"
+}

Makefile

@@ -1,5 +1,6 @@
 TF_DIRS = $(patsubst %/main.tf, %, $(shell find . -type d -name .terraform -prune -o -name 'main.tf' -print))
 VALIDATE_TF_DIRS = $(addprefix validate-,$(TF_DIRS))
+LINT_TF_DIRS = $(addprefix lint-,$(TF_DIRS))
 DOCS_TF_DIRS = $(addprefix docs-,$(TF_DIRS))
 
 # Generate docs for a terraform directories
@@ -30,3 +31,16 @@ $(VALIDATE_TF_DIRS): validate-%:
 # Validate all terraform directories
 validate: $(VALIDATE_TF_DIRS)
  @echo "All validated"
+
+# Lint a terraform directories
+$(LINT_TF_DIRS): lint-%:
+ @echo "Lint $*"
+ tflint --config "$(PWD)/.tflint.hcl" --chdir="$*"
+
+# Initialize tflint
+lint-init:
+ tflint --init
+
+# Lint all terraform directories
+lint: lint-init $(LINT_TF_DIRS)
+ @echo "All linted"

examples/postgres/README.md

@@ -1,11 +1,16 @@
 <!-- BEGIN_TF_DOCS -->
+## Requirements
 
+| Name | Version |
+|------|---------|
+| terraform | >= 1.3.0 |
+| humanitec | ~> 0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| humanitec | n/a |
+| humanitec | ~> 0 |
 
 ## Modules
 

examples/postgres/providers.tf

@@ -1,9 +1,11 @@
 terraform {
  required_providers {
  humanitec = {
- source = "humanitec/humanitec"
+ source = "humanitec/humanitec"
+ version = "~> 0"
  }
  }
+ required_version = ">= 1.3.0"
 }
 
 

examples/redis/README.md

@@ -1,11 +1,16 @@
 <!-- BEGIN_TF_DOCS -->
+## Requirements
 
+| Name | Version |
+|------|---------|
+| terraform | >= 1.3.0 |
+| humanitec | ~> 0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| humanitec | n/a |
+| humanitec | ~> 0 |
 
 ## Modules
 

examples/redis/providers.tf

@@ -1,9 +1,11 @@
 terraform {
  required_providers {
  humanitec = {
- source = "humanitec/humanitec"
+ source = "humanitec/humanitec"
+ version = "~> 0"
  }
  }
+ required_version = ">= 1.3.0"
 }
 
 

humanitec-resource-defs/mysql/basic/README.md

@@ -1,11 +1,16 @@
 <!-- BEGIN_TF_DOCS -->
+## Requirements
 
+| Name | Version |
+|------|---------|
+| terraform | >= 1.3.0 |
+| humanitec | ~> 0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| humanitec | n/a |
+| humanitec | ~> 0 |
 
 ## Resources
 
@@ -17,7 +22,7 @@
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| prefix | n/a | `string` | `""` | no |
+| prefix | Prefix for all resources | `string` | n/a | yes |
 
 ## Outputs
 

humanitec-resource-defs/mysql/basic/providers.tf

@@ -1,7 +1,9 @@
 terraform {
  required_providers {
  humanitec = {
- source = "humanitec/humanitec"
+ source = "humanitec/humanitec"
+ version = "~> 0"
  }
  }
+ required_version = ">= 1.3.0"
 }

humanitec-resource-defs/mysql/basic/terraform.tfvars.example

@@ -1 +1,3 @@
+
+# Prefix for all resources
 prefix = ""

humanitec-resource-defs/mysql/basic/variables.tf

@@ -1,3 +1,4 @@
 variable "prefix" {
- default = ""
+ description = "Prefix for all resources"
+ type = string
 }

humanitec-resource-defs/postgres/basic/README.md

@@ -1,11 +1,16 @@
 <!-- BEGIN_TF_DOCS -->
+## Requirements
 
+| Name | Version |
+|------|---------|
+| terraform | >= 1.3.0 |
+| humanitec | ~> 0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| humanitec | n/a |
+| humanitec | ~> 0 |
 
 ## Resources
 
@@ -17,7 +22,7 @@
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| prefix | n/a | `string` | `""` | no |
+| prefix | Prefix for all resources | `string` | n/a | yes |
 
 ## Outputs
 

humanitec-resource-defs/postgres/basic/providers.tf

@@ -1,7 +1,9 @@
 terraform {
  required_providers {
  humanitec = {
- source = "humanitec/humanitec"
+ source = "humanitec/humanitec"
+ version = "~> 0"
  }
  }
+ required_version = ">= 1.3.0"
 }

humanitec-resource-defs/postgres/basic/terraform.tfvars.example

@@ -1 +1,3 @@
+
+# Prefix for all resources
 prefix = ""

humanitec-resource-defs/postgres/basic/variables.tf

@@ -1,3 +1,4 @@
 variable "prefix" {
- default = ""
+ description = "Prefix for all resources"
+ type = string
 }

humanitec-resource-defs/redis/basic/README.md

@@ -1,11 +1,16 @@
 <!-- BEGIN_TF_DOCS -->
+## Requirements
 
+| Name | Version |
+|------|---------|
+| terraform | >= 1.3.0 |
+| humanitec | ~> 0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| humanitec | n/a |
+| humanitec | ~> 0 |
 
 ## Resources
 
@@ -17,7 +22,7 @@
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| prefix | n/a | `string` | `""` | no |
+| prefix | Prefix for all resources | `string` | n/a | yes |
 
 ## Outputs
 

humanitec-resource-defs/redis/basic/providers.tf

@@ -1,7 +1,9 @@
 terraform {
  required_providers {
  humanitec = {
- source = "humanitec/humanitec"
+ source = "humanitec/humanitec"
+ version = "~> 0"
  }
  }
+ required_version = ">= 1.3.0"
 }

humanitec-resource-defs/redis/basic/terraform.tfvars.example

@@ -1 +1,3 @@
+
+# Prefix for all resources
 prefix = ""

humanitec-resource-defs/redis/basic/variables.tf

@@ -1,3 +1,4 @@
 variable "prefix" {
- default = ""
+ description = "Prefix for all resources"
+ type = string
 }