Updated pre-commit-terraform with terraform-docs 0.8.0 support (#65)

terraform-aws-modules · Jan 21, 2020 · 6afe251 · 6afe251
1 parent 3cc0ae3
commit 6afe251
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 23 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
 - repo: git://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.21.0
+  rev: v1.23.0
   hooks:
     - id: terraform_fmt
     - id: terraform_docs

diff --git a/README.md b/README.md
@@ -60,35 +60,43 @@ To run the tests:
         pytest functions/notify_slack_test.py
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Providers
+
+| Name | Version |
+|------|---------|
+| archive | n/a |
+| aws | n/a |
+| null | n/a |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| cloudwatch\_log\_group\_kms\_key\_id | The ARN of the KMS Key to use when encrypting log data for Lambda | string | `"null"` | no |
-| cloudwatch\_log\_group\_retention\_in\_days | Specifies the number of days you want to retain log events in log group for Lambda. | number | `"0"` | no |
-| cloudwatch\_log\_group\_tags | Additional tags for the Cloudwatch log group | map(string) | `{}` | no |
-| create | Whether to create all resources | bool | `"true"` | no |
-| create\_sns\_topic | Whether to create new SNS topic | bool | `"true"` | no |
-| iam\_role\_tags | Additional tags for the IAM role | map(string) | `{}` | no |
-| kms\_key\_arn | ARN of the KMS key used for decrypting slack webhook url | string | `""` | no |
-| lambda\_description | The description of the Lambda function | string | `"null"` | no |
-| lambda\_function\_name | The name of the Lambda function to create | string | `"notify_slack"` | no |
-| lambda\_function\_tags | Additional tags for the Lambda function | map(string) | `{}` | no |
-| log\_events | Boolean flag to enabled/disable logging of incoming events | string | `"false"` | no |
-| reserved\_concurrent\_executions | The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations | number | `"-1"` | no |
-| slack\_channel | The name of the channel in Slack for notifications | string | n/a | yes |
-| slack\_emoji | A custom emoji that will appear on Slack messages | string | `":aws:"` | no |
-| slack\_username | The username that will appear on Slack messages | string | n/a | yes |
-| slack\_webhook\_url | The URL of Slack webhook | string | n/a | yes |
-| sns\_topic\_name | The name of the SNS topic to create | string | n/a | yes |
-| sns\_topic\_tags | Additional tags for the SNS topic | map(string) | `{}` | no |
-| tags | A map of tags to add to all resources | map(string) | `{}` | no |
+|------|-------------|------|---------|:-----:|
+| cloudwatch\_log\_group\_kms\_key\_id | The ARN of the KMS Key to use when encrypting log data for Lambda | `string` | n/a | yes |
+| cloudwatch\_log\_group\_retention\_in\_days | Specifies the number of days you want to retain log events in log group for Lambda. | `number` | `0` | no |
+| cloudwatch\_log\_group\_tags | Additional tags for the Cloudwatch log group | `map(string)` | `{}` | no |
+| create | Whether to create all resources | `bool` | `true` | no |
+| create\_sns\_topic | Whether to create new SNS topic | `bool` | `true` | no |
+| iam\_role\_tags | Additional tags for the IAM role | `map(string)` | `{}` | no |
+| kms\_key\_arn | ARN of the KMS key used for decrypting slack webhook url | `string` | `""` | no |
+| lambda\_description | The description of the Lambda function | `string` | n/a | yes |
+| lambda\_function\_name | The name of the Lambda function to create | `string` | `"notify_slack"` | no |
+| lambda\_function\_tags | Additional tags for the Lambda function | `map(string)` | `{}` | no |
+| log\_events | Boolean flag to enabled/disable logging of incoming events | `bool` | `false` | no |
+| reserved\_concurrent\_executions | The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations | `number` | `-1` | no |
+| slack\_channel | The name of the channel in Slack for notifications | `string` | n/a | yes |
+| slack\_emoji | A custom emoji that will appear on Slack messages | `string` | `":aws:"` | no |
+| slack\_username | The username that will appear on Slack messages | `string` | n/a | yes |
+| slack\_webhook\_url | The URL of Slack webhook | `string` | n/a | yes |
+| sns\_topic\_name | The name of the SNS topic to create | `string` | n/a | yes |
+| sns\_topic\_tags | Additional tags for the SNS topic | `map(string)` | `{}` | no |
+| tags | A map of tags to add to all resources | `map(string)` | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| lambda\_cloudwatch\_log\_group\_arn | The Amazon Resource Name \(ARN\) specifying the log group |
+| lambda\_cloudwatch\_log\_group\_arn | The Amazon Resource Name (ARN) specifying the log group |
 | lambda\_iam\_role\_arn | The ARN of the IAM role used by Lambda function |
 | lambda\_iam\_role\_name | The name of the IAM role used by Lambda function |
 | notify\_slack\_lambda\_function\_arn | The ARN of the Lambda function |

diff --git a/examples/cloudwatch-alerts-to-slack/README.md b/examples/cloudwatch-alerts-to-slack/README.md
@@ -56,6 +56,16 @@ Note that in practice, encryption of the Slack webhook URL should happen differe
 Note that this example may create resources which can cost money. Run `terraform destroy` when you don't need these resources.
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+
+## Inputs
+
+No input.
+
 ## Outputs
 
 | Name | Description |

diff --git a/examples/notify-slack-simple/README.md b/examples/notify-slack-simple/README.md
@@ -19,11 +19,21 @@ $ 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 -->
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+
+## Inputs
+
+No input.
+
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| lambda\_cloudwatch\_log\_group\_arn | The Amazon Resource Name \(ARN\) specifying the log group |
+| lambda\_cloudwatch\_log\_group\_arn | The Amazon Resource Name (ARN) specifying the log group |
 | lambda\_iam\_role\_arn | The ARN of the IAM role used by Lambda function |
 | lambda\_iam\_role\_name | The name of the IAM role used by Lambda function |
 | notify\_slack\_lambda\_function\_arn | The ARN of the Lambda function |