Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

23 lines (15 loc) · 1.01 KB
Raw

Contributing

Details below apply to all Terraform modules in this project (currently aws/modules/infrastructure and kubernetes/modules/meltano).

Setup

This project relies on several tools to lint, format and validate .tf files and to generate README.md files for each module:

  • Terraform, currently version >1.0.5, installable from here
  • tflint, installable from here.
  • Linting, formatting and validation is done automatically using git pre-commit, installable from here.
  • README.md generation requires terraform-docs, installable from here.

Generating Docs

To update each modules README.md after making changes, we must run terraform-docs. E.g.

cd aws/modules/infrastructure
terraform-docs .

This will replace the readme file at aws/modules/infrastructure/README.md with any changes made to the module and header docs.