Skip to content

Commit 57604d2

Browse files
antonbabenkoantonbabenko
committed
Updated pre-commit version with new terraform-docs script
1 parent 7c29b24 commit 57604d2

File tree

11 files changed

+167
-177
lines changed

11 files changed

+167
-177
lines changed

‎.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.7.2
3+
rev: v1.7.4
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_docs
77
- repo: git://github.com/pre-commit/pre-commit-hooks
8-
rev: v1.2.3
8+
rev: v2.0.0
99
hooks:
1010
- id: check-merge-conflict

‎README.md

Lines changed: 118 additions & 119 deletions
Large diffs are not rendered by default.

‎examples/complete-vpc/README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,17 @@ $ terraform apply
1717
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.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| database_subnets | List of IDs of database subnets |
26-
| elasticache_subnets | List of IDs of elasticache subnets |
27-
| intra_subnets | List of IDs of intra subnets |
28-
| nat_public_ips | NAT gateways |
29-
| private_subnets | Subnets |
30-
| public_subnets | List of IDs of public subnets |
31-
| redshift_subnets | List of IDs of redshift subnets |
32-
| vpc_id | VPC |
24+
| database\_subnets | List of IDs of database subnets |
25+
| elasticache\_subnets | List of IDs of elasticache subnets |
26+
| intra\_subnets | List of IDs of intra subnets |
27+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
28+
| private\_subnets | List of IDs of private subnets |
29+
| public\_subnets | List of IDs of public subnets |
30+
| redshift\_subnets | List of IDs of redshift subnets |
31+
| vpc\_id | The ID of the VPC |
3332

3433
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/issue-108-route-already-exists/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,15 @@ $ terraform apply
1919
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.
2020

2121
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
22-
2322
## Outputs
2423

2524
| Name | Description |
2625
|------|-------------|
27-
| database_subnets | List of IDs of database subnets |
28-
| elasticache_subnets | List of IDs of elasticache subnets |
29-
| nat_public_ips | NAT gateways |
30-
| private_subnets | Subnets |
31-
| public_subnets | List of IDs of public subnets |
32-
| vpc_id | VPC |
26+
| database\_subnets | List of IDs of database subnets |
27+
| elasticache\_subnets | List of IDs of elasticache subnets |
28+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
29+
| private\_subnets | List of IDs of private subnets |
30+
| public\_subnets | List of IDs of public subnets |
31+
| vpc\_id | The ID of the VPC |
3332

3433
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/issue-44-asymmetric-private-subnets/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ $ terraform apply
1717
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.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| database_subnets | List of IDs of database subnets |
26-
| elasticache_subnets | List of IDs of elasticache subnets |
27-
| nat_public_ips | NAT gateways |
28-
| private_subnets | Subnets |
29-
| public_subnets | List of IDs of public subnets |
30-
| vpc_id | VPC |
24+
| database\_subnets | List of IDs of database subnets |
25+
| elasticache\_subnets | List of IDs of elasticache subnets |
26+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
27+
| private\_subnets | List of IDs of private subnets |
28+
| public\_subnets | List of IDs of public subnets |
29+
| vpc\_id | The ID of the VPC |
3130

3231
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/issue-46-no-private-subnets/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ $ terraform apply
1717
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.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| database_subnets | List of IDs of database subnets |
26-
| elasticache_subnets | List of IDs of elasticache subnets |
27-
| nat_public_ips | NAT gateways |
28-
| private_subnets | Subnets |
29-
| public_subnets | List of IDs of public subnets |
30-
| vpc_id | VPC |
24+
| database\_subnets | List of IDs of database subnets |
25+
| elasticache\_subnets | List of IDs of elasticache subnets |
26+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
27+
| private\_subnets | List of IDs of private subnets |
28+
| public\_subnets | List of IDs of public subnets |
29+
| vpc\_id | The ID of the VPC |
3130

3231
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/manage-default-vpc/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@ $ terraform apply
1717
Run `terraform destroy` when you don't need these resources.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| default_vpc_cidr_block | The CIDR block of the VPC |
26-
| default_vpc_id | Default VPC |
24+
| default\_vpc\_cidr\_block | The CIDR block of the VPC |
25+
| default\_vpc\_id | The ID of the Default VPC |
2726

2827
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/secondary-cidr-blocks/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,15 @@ $ terraform apply
1717
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.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| nat_public_ips | NAT gateways |
26-
| private_subnets | Subnets |
27-
| public_subnets | List of IDs of public subnets |
28-
| vpc_cidr_block | CIDR blocks |
29-
| vpc_id | VPC |
30-
| vpc_secondary_cidr_blocks | List of secondary CIDR blocks of the VPC |
24+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
25+
| private\_subnets | List of IDs of private subnets |
26+
| public\_subnets | List of IDs of public subnets |
27+
| vpc\_cidr\_block | The CIDR block of the VPC |
28+
| vpc\_id | The ID of the VPC |
29+
| vpc\_secondary\_cidr\_blocks | List of secondary CIDR blocks of the VPC |
3130

3231
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/simple-vpc/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,14 @@ $ terraform apply
1717
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.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| nat_public_ips | NAT gateways |
26-
| private_subnets | Subnets |
27-
| public_subnets | List of IDs of public subnets |
28-
| vpc_cidr_block | CIDR blocks |
29-
| vpc_id | VPC |
24+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
25+
| private\_subnets | List of IDs of private subnets |
26+
| public\_subnets | List of IDs of public subnets |
27+
| vpc\_cidr\_block | The CIDR block of the VPC |
28+
| vpc\_id | The ID of the VPC |
3029

3130
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/test_fixture/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@ Finished in 4.25 seconds (files took 2.75 seconds to load)
2121
This will destroy any existing test resources, create the resources afresh, run the tests, report back, and destroy the resources.
2222

2323
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
24-
2524
## Inputs
2625

2726
| Name | Description | Type | Default | Required |
2827
|------|-------------|:----:|:-----:|:-----:|
29-
| region | | string | `eu-west-1` | no |
28+
| region | - | string | `eu-west-1` | no |
3029

3130
## Outputs
3231

‎examples/vpc-separate-private-route-tables/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,16 @@ $ terraform apply
1717
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.
1818

1919
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
20-
2120
## Outputs
2221

2322
| Name | Description |
2423
|------|-------------|
25-
| database_subnets | List of IDs of database subnets |
26-
| elasticache_subnets | List of IDs of elasticache subnets |
27-
| nat_public_ips | NAT gateways |
28-
| private_subnets | Subnets |
29-
| public_subnets | List of IDs of public subnets |
30-
| redshift_subnets | List of IDs of elasticache subnets |
31-
| vpc_id | VPC |
24+
| database\_subnets | List of IDs of database subnets |
25+
| elasticache\_subnets | List of IDs of elasticache subnets |
26+
| nat\_public\_ips | List of public Elastic IPs created for AWS NAT Gateway |
27+
| private\_subnets | List of IDs of private subnets |
28+
| public\_subnets | List of IDs of public subnets |
29+
| redshift\_subnets | List of IDs of elasticache subnets |
30+
| vpc\_id | The ID of the VPC |
3231

3332
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)