Updated pre-commit version with new terraform-docs script

terraform-aws-modules · Dec 11, 2018 · 57604d2 · 57604d2
1 parent 7c29b24
commit 57604d2
Show file tree

Hide file tree

Showing 11 changed files with 167 additions and 177 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,10 +1,10 @@
 repos:
 - repo: git://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.7.2
+  rev: v1.7.4
   hooks:
     - id: terraform_fmt
     - id: terraform_docs
 - repo: git://github.com/pre-commit/pre-commit-hooks
-  rev: v1.2.3
+  rev: v2.0.0
   hooks:
     - id: check-merge-conflict
diff --git a/README.md b/README.md
diff --git a/examples/complete-vpc/README.md b/examples/complete-vpc/README.md
@@ -17,18 +17,17 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| database_subnets | List of IDs of database subnets |
-| elasticache_subnets | List of IDs of elasticache subnets |
-| intra_subnets | List of IDs of intra subnets |
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| redshift_subnets | List of IDs of redshift subnets |
-| vpc_id | VPC |
+| database\_subnets | List of IDs of database subnets |
+| elasticache\_subnets | List of IDs of elasticache subnets |
+| intra\_subnets | List of IDs of intra subnets |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| redshift\_subnets | List of IDs of redshift subnets |
+| vpc\_id | The ID of the VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/issue-108-route-already-exists/README.md b/examples/issue-108-route-already-exists/README.md
@@ -19,16 +19,15 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| database_subnets | List of IDs of database subnets |
-| elasticache_subnets | List of IDs of elasticache subnets |
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| vpc_id | VPC |
+| database\_subnets | List of IDs of database subnets |
+| elasticache\_subnets | List of IDs of elasticache subnets |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| vpc\_id | The ID of the VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/issue-44-asymmetric-private-subnets/README.md b/examples/issue-44-asymmetric-private-subnets/README.md
@@ -17,16 +17,15 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| database_subnets | List of IDs of database subnets |
-| elasticache_subnets | List of IDs of elasticache subnets |
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| vpc_id | VPC |
+| database\_subnets | List of IDs of database subnets |
+| elasticache\_subnets | List of IDs of elasticache subnets |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| vpc\_id | The ID of the VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/issue-46-no-private-subnets/README.md b/examples/issue-46-no-private-subnets/README.md
@@ -17,16 +17,15 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| database_subnets | List of IDs of database subnets |
-| elasticache_subnets | List of IDs of elasticache subnets |
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| vpc_id | VPC |
+| database\_subnets | List of IDs of database subnets |
+| elasticache\_subnets | List of IDs of elasticache subnets |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| vpc\_id | The ID of the VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/manage-default-vpc/README.md b/examples/manage-default-vpc/README.md
@@ -17,12 +17,11 @@ $ terraform apply
 Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| default_vpc_cidr_block | The CIDR block of the VPC |
-| default_vpc_id | Default VPC |
+| default\_vpc\_cidr\_block | The CIDR block of the VPC |
+| default\_vpc\_id | The ID of the Default VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/secondary-cidr-blocks/README.md b/examples/secondary-cidr-blocks/README.md
@@ -17,16 +17,15 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| vpc_cidr_block | CIDR blocks |
-| vpc_id | VPC |
-| vpc_secondary_cidr_blocks | List of secondary CIDR blocks of the VPC |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| vpc\_cidr\_block | The CIDR block of the VPC |
+| vpc\_id | The ID of the VPC |
+| vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
 
  <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/simple-vpc/README.md b/examples/simple-vpc/README.md
@@ -17,15 +17,14 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| vpc_cidr_block | CIDR blocks |
-| vpc_id | VPC |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| vpc\_cidr\_block | The CIDR block of the VPC |
+| vpc\_id | The ID of the VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
diff --git a/examples/test_fixture/README.md b/examples/test_fixture/README.md
@@ -21,12 +21,11 @@ Finished in 4.25 seconds (files took 2.75 seconds to load)
 This will destroy any existing test resources, create the resources afresh, run the tests, report back, and destroy the resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|:----:|:-----:|:-----:|
-| region |  | string | `eu-west-1` | no |
+| region | - | string | `eu-west-1` | no |
 
 ## Outputs
 

diff --git a/examples/vpc-separate-private-route-tables/README.md b/examples/vpc-separate-private-route-tables/README.md
@@ -17,17 +17,16 @@ $ terraform apply
 Note that this example may create resources which can cost money (AWS Elastic IP, for example). Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| database_subnets | List of IDs of database subnets |
-| elasticache_subnets | List of IDs of elasticache subnets |
-| nat_public_ips | NAT gateways |
-| private_subnets | Subnets |
-| public_subnets | List of IDs of public subnets |
-| redshift_subnets | List of IDs of elasticache subnets |
-| vpc_id | VPC |
+| database\_subnets | List of IDs of database subnets |
+| elasticache\_subnets | List of IDs of elasticache subnets |
+| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
+| private\_subnets | List of IDs of private subnets |
+| public\_subnets | List of IDs of public subnets |
+| redshift\_subnets | List of IDs of elasticache subnets |
+| vpc\_id | The ID of the VPC |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->