Skip to content

Commit fe1dfcb

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation and pin terraform_docs version to avoid future changes (#134)
1 parent 80d2c42 commit fe1dfcb

File tree

16 files changed

+600
-573
lines changed

16 files changed

+600
-573
lines changed

‎.github/workflows/pre-commit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ jobs:
9494
- name: Install pre-commit dependencies
9595
run: |
9696
pip install pre-commit
97-
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
97+
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/latest | grep -o -E "https://.+?-v0.12.0-linux-amd64" | head -n1)" > terraform-docs && chmod +x terraform-docs && sudo mv terraform-docs /usr/bin/
9898
curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/latest | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && sudo mv tflint /usr/bin/
9999
- name: Execute pre-commit
100100
# Run all pre-commit checks on max version supported

‎.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
repos:
22
- repo: git://github.com/antonbabenko/pre-commit-terraform
3-
rev: v1.46.0
3+
rev: v1.48.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate

‎README.md

Lines changed: 167 additions & 146 deletions
Large diffs are not rendered by default.

‎examples/alias/README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -19,60 +19,60 @@ Note that this example may create resources which cost money. Run `terraform des
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.26 |
23-
| aws | >= 3.19 |
24-
| random | >= 2 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.19 |
24+
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2 |
2525

2626
## Providers
2727

2828
| Name | Version |
2929
|------|---------|
30-
| random | >= 2 |
30+
| <a name="provider_random"></a> [random](#provider\_random) | >= 2 |
3131

3232
## Modules
3333

3434
| Name | Source | Version |
3535
|------|--------|---------|
36-
| alias_existing | ../../modules/alias | |
37-
| alias_no_refresh | ../../modules/alias | |
38-
| alias_refresh | ../../modules/alias | |
39-
| lambda_function | ../../ | |
36+
| <a name="module_alias_existing"></a> [alias\_existing](#module\_alias\_existing) | ../../modules/alias | |
37+
| <a name="module_alias_no_refresh"></a> [alias\_no\_refresh](#module\_alias\_no\_refresh) | ../../modules/alias | |
38+
| <a name="module_alias_refresh"></a> [alias\_refresh](#module\_alias\_refresh) | ../../modules/alias | |
39+
| <a name="module_lambda_function"></a> [lambda\_function](#module\_lambda\_function) | ../../ | |
4040

4141
## Resources
4242

43-
| Name |
44-
|------|
45-
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
43+
| Name | Type |
44+
|------|------|
45+
| [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |
4646

4747
## Inputs
4848

49-
No input.
49+
No inputs.
5050

5151
## Outputs
5252

5353
| Name | Description |
5454
|------|-------------|
55-
| lambda\_role\_arn | The ARN of the IAM role created for the Lambda Function |
56-
| lambda\_role\_name | The name of the IAM role created for the Lambda Function |
57-
| local\_filename | The filename of zip archive deployed (if deployment was from local) |
58-
| s3\_object | The map with S3 object data of zip archive deployed (if deployment was from S3) |
59-
| this\_lambda\_alias\_arn | The ARN of the Lambda Function Alias |
60-
| this\_lambda\_alias\_description | Description of alias |
61-
| this\_lambda\_alias\_function\_version | Lambda function version which the alias uses |
62-
| this\_lambda\_alias\_invoke\_arn | The ARN to be used for invoking Lambda Function from API Gateway |
63-
| this\_lambda\_alias\_name | The name of the Lambda Function Alias |
64-
| this\_lambda\_function\_arn | The ARN of the Lambda Function |
65-
| this\_lambda\_function\_invoke\_arn | The Invoke ARN of the Lambda Function |
66-
| this\_lambda\_function\_kms\_key\_arn | The ARN for the KMS encryption key of Lambda Function |
67-
| this\_lambda\_function\_last\_modified | The date Lambda Function resource was last modified |
68-
| this\_lambda\_function\_name | The name of the Lambda Function |
69-
| this\_lambda\_function\_qualified\_arn | The ARN identifying your Lambda Function Version |
70-
| this\_lambda\_function\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the zip file |
71-
| this\_lambda\_function\_source\_code\_size | The size in bytes of the function .zip file |
72-
| this\_lambda\_function\_version | Latest published version of Lambda Function |
73-
| this\_lambda\_layer\_arn | The ARN of the Lambda Layer with version |
74-
| this\_lambda\_layer\_created\_date | The date Lambda Layer resource was created |
75-
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
76-
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
77-
| this\_lambda\_layer\_version | The Lambda Layer version |
55+
| <a name="output_lambda_role_arn"></a> [lambda\_role\_arn](#output\_lambda\_role\_arn) | The ARN of the IAM role created for the Lambda Function |
56+
| <a name="output_lambda_role_name"></a> [lambda\_role\_name](#output\_lambda\_role\_name) | The name of the IAM role created for the Lambda Function |
57+
| <a name="output_local_filename"></a> [local\_filename](#output\_local\_filename) | The filename of zip archive deployed (if deployment was from local) |
58+
| <a name="output_s3_object"></a> [s3\_object](#output\_s3\_object) | The map with S3 object data of zip archive deployed (if deployment was from S3) |
59+
| <a name="output_this_lambda_alias_arn"></a> [this\_lambda\_alias\_arn](#output\_this\_lambda\_alias\_arn) | The ARN of the Lambda Function Alias |
60+
| <a name="output_this_lambda_alias_description"></a> [this\_lambda\_alias\_description](#output\_this\_lambda\_alias\_description) | Description of alias |
61+
| <a name="output_this_lambda_alias_function_version"></a> [this\_lambda\_alias\_function\_version](#output\_this\_lambda\_alias\_function\_version) | Lambda function version which the alias uses |
62+
| <a name="output_this_lambda_alias_invoke_arn"></a> [this\_lambda\_alias\_invoke\_arn](#output\_this\_lambda\_alias\_invoke\_arn) | The ARN to be used for invoking Lambda Function from API Gateway |
63+
| <a name="output_this_lambda_alias_name"></a> [this\_lambda\_alias\_name](#output\_this\_lambda\_alias\_name) | The name of the Lambda Function Alias |
64+
| <a name="output_this_lambda_function_arn"></a> [this\_lambda\_function\_arn](#output\_this\_lambda\_function\_arn) | The ARN of the Lambda Function |
65+
| <a name="output_this_lambda_function_invoke_arn"></a> [this\_lambda\_function\_invoke\_arn](#output\_this\_lambda\_function\_invoke\_arn) | The Invoke ARN of the Lambda Function |
66+
| <a name="output_this_lambda_function_kms_key_arn"></a> [this\_lambda\_function\_kms\_key\_arn](#output\_this\_lambda\_function\_kms\_key\_arn) | The ARN for the KMS encryption key of Lambda Function |
67+
| <a name="output_this_lambda_function_last_modified"></a> [this\_lambda\_function\_last\_modified](#output\_this\_lambda\_function\_last\_modified) | The date Lambda Function resource was last modified |
68+
| <a name="output_this_lambda_function_name"></a> [this\_lambda\_function\_name](#output\_this\_lambda\_function\_name) | The name of the Lambda Function |
69+
| <a name="output_this_lambda_function_qualified_arn"></a> [this\_lambda\_function\_qualified\_arn](#output\_this\_lambda\_function\_qualified\_arn) | The ARN identifying your Lambda Function Version |
70+
| <a name="output_this_lambda_function_source_code_hash"></a> [this\_lambda\_function\_source\_code\_hash](#output\_this\_lambda\_function\_source\_code\_hash) | Base64-encoded representation of raw SHA-256 sum of the zip file |
71+
| <a name="output_this_lambda_function_source_code_size"></a> [this\_lambda\_function\_source\_code\_size](#output\_this\_lambda\_function\_source\_code\_size) | The size in bytes of the function .zip file |
72+
| <a name="output_this_lambda_function_version"></a> [this\_lambda\_function\_version](#output\_this\_lambda\_function\_version) | Latest published version of Lambda Function |
73+
| <a name="output_this_lambda_layer_arn"></a> [this\_lambda\_layer\_arn](#output\_this\_lambda\_layer\_arn) | The ARN of the Lambda Layer with version |
74+
| <a name="output_this_lambda_layer_created_date"></a> [this\_lambda\_layer\_created\_date](#output\_this\_lambda\_layer\_created\_date) | The date Lambda Layer resource was created |
75+
| <a name="output_this_lambda_layer_layer_arn"></a> [this\_lambda\_layer\_layer\_arn](#output\_this\_lambda\_layer\_layer\_arn) | The ARN of the Lambda Layer without version |
76+
| <a name="output_this_lambda_layer_source_code_size"></a> [this\_lambda\_layer\_source\_code\_size](#output\_this\_lambda\_layer\_source\_code\_size) | The size in bytes of the Lambda Layer .zip file |
77+
| <a name="output_this_lambda_layer_version"></a> [this\_lambda\_layer\_version](#output\_this\_lambda\_layer\_version) | The Lambda Layer version |
7878
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/async/README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,56 +19,56 @@ Note that this example may create resources which cost money. Run `terraform des
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.26 |
23-
| aws | >= 3.19 |
24-
| random | >= 2 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.19 |
24+
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2 |
2525

2626
## Providers
2727

2828
| Name | Version |
2929
|------|---------|
30-
| aws | >= 3.19 |
31-
| random | >= 2 |
30+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.19 |
31+
| <a name="provider_random"></a> [random](#provider\_random) | >= 2 |
3232

3333
## Modules
3434

3535
| Name | Source | Version |
3636
|------|--------|---------|
37-
| lambda_function | ../../ | |
37+
| <a name="module_lambda_function"></a> [lambda\_function](#module\_lambda\_function) | ../../ | |
3838

3939
## Resources
4040

41-
| Name |
42-
|------|
43-
| [aws_sns_topic](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic) |
44-
| [aws_sqs_queue](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) |
45-
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
41+
| Name | Type |
42+
|------|------|
43+
| [aws_sns_topic.async](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic) | resource |
44+
| [aws_sqs_queue.async](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sqs_queue) | resource |
45+
| [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |
4646

4747
## Inputs
4848

49-
No input.
49+
No inputs.
5050

5151
## Outputs
5252

5353
| Name | Description |
5454
|------|-------------|
55-
| lambda\_cloudwatch\_log\_group\_arn | The ARN of the Cloudwatch Log Group |
56-
| lambda\_role\_arn | The ARN of the IAM role created for the Lambda Function |
57-
| lambda\_role\_name | The name of the IAM role created for the Lambda Function |
58-
| local\_filename | The filename of zip archive deployed (if deployment was from local) |
59-
| s3\_object | The map with S3 object data of zip archive deployed (if deployment was from S3) |
60-
| this\_lambda\_function\_arn | The ARN of the Lambda Function |
61-
| this\_lambda\_function\_invoke\_arn | The Invoke ARN of the Lambda Function |
62-
| this\_lambda\_function\_kms\_key\_arn | The ARN for the KMS encryption key of Lambda Function |
63-
| this\_lambda\_function\_last\_modified | The date Lambda Function resource was last modified |
64-
| this\_lambda\_function\_name | The name of the Lambda Function |
65-
| this\_lambda\_function\_qualified\_arn | The ARN identifying your Lambda Function Version |
66-
| this\_lambda\_function\_source\_code\_hash | Base64-encoded representation of raw SHA-256 sum of the zip file |
67-
| this\_lambda\_function\_source\_code\_size | The size in bytes of the function .zip file |
68-
| this\_lambda\_function\_version | Latest published version of Lambda Function |
69-
| this\_lambda\_layer\_arn | The ARN of the Lambda Layer with version |
70-
| this\_lambda\_layer\_created\_date | The date Lambda Layer resource was created |
71-
| this\_lambda\_layer\_layer\_arn | The ARN of the Lambda Layer without version |
72-
| this\_lambda\_layer\_source\_code\_size | The size in bytes of the Lambda Layer .zip file |
73-
| this\_lambda\_layer\_version | The Lambda Layer version |
55+
| <a name="output_lambda_cloudwatch_log_group_arn"></a> [lambda\_cloudwatch\_log\_group\_arn](#output\_lambda\_cloudwatch\_log\_group\_arn) | The ARN of the Cloudwatch Log Group |
56+
| <a name="output_lambda_role_arn"></a> [lambda\_role\_arn](#output\_lambda\_role\_arn) | The ARN of the IAM role created for the Lambda Function |
57+
| <a name="output_lambda_role_name"></a> [lambda\_role\_name](#output\_lambda\_role\_name) | The name of the IAM role created for the Lambda Function |
58+
| <a name="output_local_filename"></a> [local\_filename](#output\_local\_filename) | The filename of zip archive deployed (if deployment was from local) |
59+
| <a name="output_s3_object"></a> [s3\_object](#output\_s3\_object) | The map with S3 object data of zip archive deployed (if deployment was from S3) |
60+
| <a name="output_this_lambda_function_arn"></a> [this\_lambda\_function\_arn](#output\_this\_lambda\_function\_arn) | The ARN of the Lambda Function |
61+
| <a name="output_this_lambda_function_invoke_arn"></a> [this\_lambda\_function\_invoke\_arn](#output\_this\_lambda\_function\_invoke\_arn) | The Invoke ARN of the Lambda Function |
62+
| <a name="output_this_lambda_function_kms_key_arn"></a> [this\_lambda\_function\_kms\_key\_arn](#output\_this\_lambda\_function\_kms\_key\_arn) | The ARN for the KMS encryption key of Lambda Function |
63+
| <a name="output_this_lambda_function_last_modified"></a> [this\_lambda\_function\_last\_modified](#output\_this\_lambda\_function\_last\_modified) | The date Lambda Function resource was last modified |
64+
| <a name="output_this_lambda_function_name"></a> [this\_lambda\_function\_name](#output\_this\_lambda\_function\_name) | The name of the Lambda Function |
65+
| <a name="output_this_lambda_function_qualified_arn"></a> [this\_lambda\_function\_qualified\_arn](#output\_this\_lambda\_function\_qualified\_arn) | The ARN identifying your Lambda Function Version |
66+
| <a name="output_this_lambda_function_source_code_hash"></a> [this\_lambda\_function\_source\_code\_hash](#output\_this\_lambda\_function\_source\_code\_hash) | Base64-encoded representation of raw SHA-256 sum of the zip file |
67+
| <a name="output_this_lambda_function_source_code_size"></a> [this\_lambda\_function\_source\_code\_size](#output\_this\_lambda\_function\_source\_code\_size) | The size in bytes of the function .zip file |
68+
| <a name="output_this_lambda_function_version"></a> [this\_lambda\_function\_version](#output\_this\_lambda\_function\_version) | Latest published version of Lambda Function |
69+
| <a name="output_this_lambda_layer_arn"></a> [this\_lambda\_layer\_arn](#output\_this\_lambda\_layer\_arn) | The ARN of the Lambda Layer with version |
70+
| <a name="output_this_lambda_layer_created_date"></a> [this\_lambda\_layer\_created\_date](#output\_this\_lambda\_layer\_created\_date) | The date Lambda Layer resource was created |
71+
| <a name="output_this_lambda_layer_layer_arn"></a> [this\_lambda\_layer\_layer\_arn](#output\_this\_lambda\_layer\_layer\_arn) | The ARN of the Lambda Layer without version |
72+
| <a name="output_this_lambda_layer_source_code_size"></a> [this\_lambda\_layer\_source\_code\_size](#output\_this\_lambda\_layer\_source\_code\_size) | The size in bytes of the Lambda Layer .zip file |
73+
| <a name="output_this_lambda_layer_version"></a> [this\_lambda\_layer\_version](#output\_this\_lambda\_layer\_version) | The Lambda Layer version |
7474
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

‎examples/build-package/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,42 +19,42 @@ Note that this example may create resources which cost money. Run `terraform des
1919

2020
| Name | Version |
2121
|------|---------|
22-
| terraform | >= 0.12.26 |
23-
| aws | >= 3.19 |
24-
| random | >= 2 |
22+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
23+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.19 |
24+
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 2 |
2525

2626
## Providers
2727

2828
| Name | Version |
2929
|------|---------|
30-
| random | >= 2 |
30+
| <a name="provider_random"></a> [random](#provider\_random) | >= 2 |
3131

3232
## Modules
3333

3434
| Name | Source | Version |
3535
|------|--------|---------|
36-
| lambda_function_from_package | ../../ | |
37-
| lambda_layer | ../../ | |
38-
| package_dir | ../../ | |
39-
| package_dir_without_pip_install | ../../ | |
40-
| package_file | ../../ | |
41-
| package_file_with_pip_requirements | ../../ | |
42-
| package_with_commands_and_patterns | ../../ | |
43-
| package_with_docker | ../../ | |
44-
| package_with_patterns | ../../ | |
45-
| package_with_pip_requirements_in_docker | ../../ | |
36+
| <a name="module_lambda_function_from_package"></a> [lambda\_function\_from\_package](#module\_lambda\_function\_from\_package) | ../../ | |
37+
| <a name="module_lambda_layer"></a> [lambda\_layer](#module\_lambda\_layer) | ../../ | |
38+
| <a name="module_package_dir"></a> [package\_dir](#module\_package\_dir) | ../../ | |
39+
| <a name="module_package_dir_without_pip_install"></a> [package\_dir\_without\_pip\_install](#module\_package\_dir\_without\_pip\_install) | ../../ | |
40+
| <a name="module_package_file"></a> [package\_file](#module\_package\_file) | ../../ | |
41+
| <a name="module_package_file_with_pip_requirements"></a> [package\_file\_with\_pip\_requirements](#module\_package\_file\_with\_pip\_requirements) | ../../ | |
42+
| <a name="module_package_with_commands_and_patterns"></a> [package\_with\_commands\_and\_patterns](#module\_package\_with\_commands\_and\_patterns) | ../../ | |
43+
| <a name="module_package_with_docker"></a> [package\_with\_docker](#module\_package\_with\_docker) | ../../ | |
44+
| <a name="module_package_with_patterns"></a> [package\_with\_patterns](#module\_package\_with\_patterns) | ../../ | |
45+
| <a name="module_package_with_pip_requirements_in_docker"></a> [package\_with\_pip\_requirements\_in\_docker](#module\_package\_with\_pip\_requirements\_in\_docker) | ../../ | |
4646

4747
## Resources
4848

49-
| Name |
50-
|------|
51-
| [random_pet](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) |
49+
| Name | Type |
50+
|------|------|
51+
| [random_pet.this](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |
5252

5353
## Inputs
5454

55-
No input.
55+
No inputs.
5656

5757
## Outputs
5858

59-
No output.
59+
No outputs.
6060
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)