Merge pull request #189 from cisagov/improvement/add_terraform-docs_c…

…onfiguration Add a configuration file for `terraform-docs`
cisagov · Nov 29, 2023 · ca595f9 · ca595f9
2 parents 6397a1c + c2b4c6c
commit ca595f9
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.terraform-docs.yml b/.terraform-docs.yml
@@ -0,0 +1,13 @@
+---
+formatter: markdown table
+output:
+  file: README.md
+  mode: inject
+  template: |-
+    <!-- BEGIN_TF_DOCS -->
+    {{ .Content }}
+    <!-- END_TF_DOCS -->
+settings:
+  anchor: false
+  html: false
+  lockfile: false
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ module "example" {
 
 - [Basic usage](https://github.com/cisagov/skeleton-tf-module/tree/develop/examples/basic_usage)
 
+<!-- BEGIN_TF_DOCS -->
 ## Requirements ##
 
 | Name | Version |
@@ -73,6 +74,7 @@ No modules.
 | id | The EC2 instance ID. |
 | private\_ip | The private IP of the EC2 instance. |
 | subnet\_id | The ID of the subnet where the EC2 instance is deployed. |
+<!-- END_TF_DOCS -->
 
 ## Notes ##