Skip to content

Commit 32c75aa

Browse files
bryantbiggsbryantbiggs
authored
chore: update documentation and pin terraform_docs version to avoid future changes (#36)
1 parent f0caef5 commit 32c75aa

File tree

4 files changed

+37
-37
lines changed

4 files changed

+37
-37
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.47.0
3+
rev: v1.48.0
44
hooks:
55
- id: terraform_fmt
66
- id: terraform_validate

‎README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -63,43 +63,43 @@ module "ecs" {
6363

6464
| Name | Version |
6565
|------|---------|
66-
| terraform | >= 0.12.26 |
67-
| aws | >= 2.48 |
66+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
67+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.48 |
6868

6969
## Providers
7070

7171
| Name | Version |
7272
|------|---------|
73-
| aws | >= 2.48 |
73+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.48 |
7474

7575
## Modules
7676

77-
No Modules.
77+
No modules.
7878

7979
## Resources
8080

81-
| Name |
82-
|------|
83-
| [aws_ecs_cluster](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_cluster) |
81+
| Name | Type |
82+
|------|------|
83+
| [aws_ecs_cluster.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_cluster) | resource |
8484

8585
## Inputs
8686

8787
| Name | Description | Type | Default | Required |
8888
|------|-------------|------|---------|:--------:|
89-
| capacity\_providers | List of short names of one or more capacity providers to associate with the cluster. Valid values also include FARGATE and FARGATE\_SPOT. | `list(string)` | `[]` | no |
90-
| container\_insights | Controls if ECS Cluster has container insights enabled | `bool` | `false` | no |
91-
| create\_ecs | Controls if ECS should be created | `bool` | `true` | no |
92-
| default\_capacity\_provider\_strategy | The capacity provider strategy to use by default for the cluster. Can be one or more. | `list(map(any))` | `[]` | no |
93-
| name | Name to be used on all the resources as identifier, also the name of the ECS cluster | `string` | `null` | no |
94-
| tags | A map of tags to add to ECS Cluster | `map(string)` | `{}` | no |
89+
| <a name="input_capacity_providers"></a> [capacity\_providers](#input\_capacity\_providers) | List of short names of one or more capacity providers to associate with the cluster. Valid values also include FARGATE and FARGATE\_SPOT. | `list(string)` | `[]` | no |
90+
| <a name="input_container_insights"></a> [container\_insights](#input\_container\_insights) | Controls if ECS Cluster has container insights enabled | `bool` | `false` | no |
91+
| <a name="input_create_ecs"></a> [create\_ecs](#input\_create\_ecs) | Controls if ECS should be created | `bool` | `true` | no |
92+
| <a name="input_default_capacity_provider_strategy"></a> [default\_capacity\_provider\_strategy](#input\_default\_capacity\_provider\_strategy) | The capacity provider strategy to use by default for the cluster. Can be one or more. | `list(map(any))` | `[]` | no |
93+
| <a name="input_name"></a> [name](#input\_name) | Name to be used on all the resources as identifier, also the name of the ECS cluster | `string` | `null` | no |
94+
| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to add to ECS Cluster | `map(string)` | `{}` | no |
9595

9696
## Outputs
9797

9898
| Name | Description |
9999
|------|-------------|
100-
| this\_ecs\_cluster\_arn | ARN of the ECS Cluster |
101-
| this\_ecs\_cluster\_id | ID of the ECS Cluster |
102-
| this\_ecs\_cluster\_name | The name of the ECS cluster |
100+
| <a name="output_this_ecs_cluster_arn"></a> [this\_ecs\_cluster\_arn](#output\_this\_ecs\_cluster\_arn) | ARN of the ECS Cluster |
101+
| <a name="output_this_ecs_cluster_id"></a> [this\_ecs\_cluster\_id](#output\_this\_ecs\_cluster\_id) | ID of the ECS Cluster |
102+
| <a name="output_this_ecs_cluster_name"></a> [this\_ecs\_cluster\_name](#output\_this\_ecs\_cluster\_name) | The name of the ECS cluster |
103103
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
104104

105105
## Authors

‎examples/complete-ecs/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -43,42 +43,42 @@ Current version creates an high-available VPC with instances that are attached t
4343

4444
| Name | Version |
4545
|------|---------|
46-
| terraform | >= 0.12.26 |
47-
| aws | >= 2.48 |
48-
| template | >= 2.0 |
46+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.12.26 |
47+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.48 |
48+
| <a name="requirement_template"></a> [template](#requirement\_template) | >= 2.0 |
4949

5050
## Providers
5151

5252
| Name | Version |
5353
|------|---------|
54-
| aws | >= 2.48 |
55-
| template | >= 2.0 |
54+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 2.48 |
55+
| <a name="provider_template"></a> [template](#provider\_template) | >= 2.0 |
5656

5757
## Modules
5858

5959
| Name | Source | Version |
6060
|------|--------|---------|
61-
| asg | terraform-aws-modules/autoscaling/aws | ~> 3.0 |
62-
| disabled_ecs | ../../ | |
63-
| ec2_profile | ../../modules/ecs-instance-profile | |
64-
| ecs | ../../ | |
65-
| hello_world | ./service-hello-world | |
66-
| vpc | terraform-aws-modules/vpc/aws | ~> 2.0 |
61+
| <a name="module_asg"></a> [asg](#module\_asg) | terraform-aws-modules/autoscaling/aws | ~> 3.0 |
62+
| <a name="module_disabled_ecs"></a> [disabled\_ecs](#module\_disabled\_ecs) | ../../ | |
63+
| <a name="module_ec2_profile"></a> [ec2\_profile](#module\_ec2\_profile) | ../../modules/ecs-instance-profile | |
64+
| <a name="module_ecs"></a> [ecs](#module\_ecs) | ../../ | |
65+
| <a name="module_hello_world"></a> [hello\_world](#module\_hello\_world) | ./service-hello-world | |
66+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 2.0 |
6767

6868
## Resources
6969

70-
| Name |
71-
|------|
72-
| [aws_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) |
73-
| [aws_availability_zones](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) |
74-
| [aws_ecs_capacity_provider](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_capacity_provider) |
75-
| [template_file](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) |
70+
| Name | Type |
71+
|------|------|
72+
| [aws_ecs_capacity_provider.prov1](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_capacity_provider) | resource |
73+
| [aws_ami.amazon_linux_ecs](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |
74+
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
75+
| [template_file.user_data](https://registry.terraform.io/providers/hashicorp/template/latest/docs/data-sources/file) | data source |
7676

7777
## Inputs
7878

79-
No input.
79+
No inputs.
8080

8181
## Outputs
8282

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

0 commit comments

Comments
 (0)