Skip to content

Commit fe2fe90

Browse files
heregithub-actions[bot]
here
and
github-actions[bot]
authored
GitHub Actions - Automate Terraform Docs #66 (#111)
* gh terraform-plan generate docs init #66 #66 * fix: github terraform-plan permissions * terraform-docs: automated action * Revert "terraform-docs: automated action" This reverts commit 870dec8. * feat: github terraform-docs recursive * terraform-docs: automated updates to Terraform modules README.md * empty commit * github terraform-docs expand search for tf * terraform-docs rm recursive use find-dir * terraform-docs: automated updates to Terraform modules README.md --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent ea75d55 commit fe2fe90

30 files changed

Lines changed: 775 additions & 232 deletions

File tree

‎.github/workflows/terraform-plan.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,25 @@ jobs:
4242
with:
4343
path: terraform
4444
backend_config_file: terraform/prod.backend.tfvars
45+
46+
terraform-docs:
47+
name: Generate Terraform Docs
48+
runs-on: ubuntu-latest
49+
50+
permissions:
51+
contents: write
52+
pull-requests: write
53+
54+
steps:
55+
- uses: actions/checkout@v3
56+
with:
57+
ref: ${{ github.event.pull_request.head.ref }}
58+
59+
- name: Render terraform docs inside the README.md and push changes back to PR branch
60+
uses: terraform-docs/gh-actions@v1.4.1
61+
with:
62+
find-dir: "terraform"
63+
output-file: README.md
64+
output-method: inject
65+
git-push: "true"
66+
git-commit-message: "terraform-docs: automated updates to Terraform modules README.md"

‎terraform/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | ~> 1.12 |
7+
| <a name="requirement_postgresql"></a> [postgresql](#requirement\_postgresql) | 1.25.0 |
8+
9+
## Providers
10+
11+
| Name | Version |
12+
|------|---------|
13+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
14+
15+
## Modules
16+
17+
| Name | Source | Version |
18+
|------|--------|---------|
19+
| <a name="module_civic-tech-index"></a> [civic-tech-index](#module\_civic-tech-index) | ./projects/civic-tech-index | n/a |
20+
| <a name="module_civic-tech-jobs"></a> [civic-tech-jobs](#module\_civic-tech-jobs) | ./projects/civic-tech-jobs | n/a |
21+
| <a name="module_home-unite-us"></a> [home-unite-us](#module\_home-unite-us) | ./projects/home-unite-us | n/a |
22+
| <a name="module_people-depot"></a> [people-depot](#module\_people-depot) | ./projects/people-depot | n/a |
23+
| <a name="module_vrms"></a> [vrms](#module\_vrms) | ./projects/vrms | n/a |
24+
25+
## Resources
26+
27+
| Name | Type |
28+
|------|------|
29+
| [aws_db_instance.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance) | resource |
30+
| [aws_iam_policy.incubator_builder](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
31+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
32+
33+
## Inputs
34+
35+
| Name | Description | Type | Default | Required |
36+
|------|-------------|------|---------|:--------:|
37+
| <a name="input_pghost"></a> [pghost](#input\_pghost) | n/a | `string` | n/a | yes |
38+
| <a name="input_pgpassword"></a> [pgpassword](#input\_pgpassword) | n/a | `string` | n/a | yes |
39+
40+
## Outputs
41+
42+
No outputs.
43+
<!-- END_TF_DOCS -->

‎terraform/modules/cicd_integration/README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
11+
12+
## Modules
13+
14+
No modules.
15+
16+
## Resources
17+
18+
| Name | Type |
19+
|------|------|
20+
| [aws_iam_role.builder](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
21+
| [aws_iam_role_policy_attachment.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
22+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
23+
24+
## Inputs
25+
26+
| Name | Description | Type | Default | Required |
27+
|------|-------------|------|---------|:--------:|
28+
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | n/a | `string` | n/a | yes |
29+
| <a name="input_repository_name"></a> [repository\_name](#input\_repository\_name) | n/a | `string` | n/a | yes |
30+
31+
## Outputs
32+
33+
| Name | Description |
34+
|------|-------------|
35+
| <a name="output_role_name"></a> [role\_name](#output\_role\_name) | n/a |
36+
<!-- END_TF_DOCS -->

‎terraform/modules/container/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
11+
12+
## Modules
13+
14+
No modules.
15+
16+
## Resources
17+
18+
| Name | Type |
19+
|------|------|
20+
| [aws_cloudwatch_log_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
21+
| [aws_ecs_service.fargate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
22+
| [aws_ecs_task_definition.task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
23+
| [aws_iam_policy.container_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | resource |
24+
| [aws_iam_role.instance](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
25+
| [aws_iam_role_policy_attachment.task_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
26+
| [aws_lb_listener_rule.static](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |
27+
| [aws_lb_target_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |
28+
| [aws_security_group.container](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
29+
| [aws_vpc_security_group_egress_rule.allow_all_traffic](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_egress_rule) | resource |
30+
| [aws_vpc_security_group_ingress_rule.container_ingress_port](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/vpc_security_group_ingress_rule) | resource |
31+
32+
## Inputs
33+
34+
| Name | Description | Type | Default | Required |
35+
|------|-------------|------|---------|:--------:|
36+
| <a name="input_additional_host_urls"></a> [additional\_host\_urls](#input\_additional\_host\_urls) | n/a | `list(string)` | `[]` | no |
37+
| <a name="input_application_type"></a> [application\_type](#input\_application\_type) | defines what type of application is running, fullstack, client, backend, etc. will be used for cloudwatch logs | `string` | n/a | yes |
38+
| <a name="input_container_cpu"></a> [container\_cpu](#input\_container\_cpu) | n/a | `number` | `512` | no |
39+
| <a name="input_container_environment"></a> [container\_environment](#input\_container\_environment) | n/a | <pre>list(object({<br/> name = string<br/> value = string<br/> }))</pre> | n/a | yes |
40+
| <a name="input_container_environment_secrets"></a> [container\_environment\_secrets](#input\_container\_environment\_secrets) | n/a | <pre>list(object({<br/> name = string<br/> valueFrom = string<br/> }))</pre> | `[]` | no |
41+
| <a name="input_container_image"></a> [container\_image](#input\_container\_image) | n/a | `string` | n/a | yes |
42+
| <a name="input_container_memory"></a> [container\_memory](#input\_container\_memory) | n/a | `number` | `1024` | no |
43+
| <a name="input_container_port"></a> [container\_port](#input\_container\_port) | n/a | `number` | n/a | yes |
44+
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
45+
| <a name="input_health_check_path"></a> [health\_check\_path](#input\_health\_check\_path) | n/a | `string` | `"/"` | no |
46+
| <a name="input_hostname"></a> [hostname](#input\_hostname) | n/a | `string` | n/a | yes |
47+
| <a name="input_listener_priority"></a> [listener\_priority](#input\_listener\_priority) | n/a | `number` | n/a | yes |
48+
| <a name="input_path"></a> [path](#input\_path) | n/a | `string` | `null` | no |
49+
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `any` | n/a | yes |
50+
51+
## Outputs
52+
53+
| Name | Description |
54+
|------|-------------|
55+
| <a name="output_task_role_arn"></a> [task\_role\_arn](#output\_task\_role\_arn) | n/a |
56+
| <a name="output_task_role_name"></a> [task\_role\_name](#output\_task\_role\_name) | n/a |
57+
<!-- END_TF_DOCS -->

‎terraform/modules/database/README.md‎

Lines changed: 36 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,62 @@
11
<!-- BEGIN_TF_DOCS -->
2-
# Database
2+
## Requirements
33

4-
Add description.
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_postgresql"></a> [postgresql](#requirement\_postgresql) | 1.25.0 |
57

8+
## Providers
69

10+
| Name | Version |
11+
|------|---------|
12+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
13+
| <a name="provider_postgresql"></a> [postgresql](#provider\_postgresql) | 1.25.0 |
14+
15+
## Modules
16+
17+
| Name | Source | Version |
18+
|------|--------|---------|
19+
| <a name="module_db_owner_password"></a> [db\_owner\_password](#module\_db\_owner\_password) | ../secret | n/a |
20+
| <a name="module_db_owner_username"></a> [db\_owner\_username](#module\_db\_owner\_username) | ../secret | n/a |
21+
| <a name="module_db_user_password"></a> [db\_user\_password](#module\_db\_user\_password) | ../secret | n/a |
22+
| <a name="module_db_user_username"></a> [db\_user\_username](#module\_db\_user\_username) | ../secret | n/a |
23+
| <a name="module_db_viewer_password"></a> [db\_viewer\_password](#module\_db\_viewer\_password) | ../secret | n/a |
24+
| <a name="module_db_viewer_username"></a> [db\_viewer\_username](#module\_db\_viewer\_username) | ../secret | n/a |
725

826
## Resources
927

1028
| Name | Type |
1129
|------|------|
12-
| [aws_ssm_parameter.rds_dbowner_password](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
13-
| [aws_ssm_parameter.rds_dbuser_password](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
14-
| [aws_ssm_parameter.rds_dbviewer_password](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssm_parameter) | resource |
15-
| [postgresql_database.db](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/database) | resource |
16-
| [postgresql_grant.user](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/grant) | resource |
17-
| [postgresql_grant.viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/grant) | resource |
18-
| [postgresql_role.db_owner](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/role) | resource |
19-
| [postgresql_role.db_user](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/role) | resource |
20-
| [postgresql_role.db_viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/latest/docs/resources/role) | resource |
30+
| [postgresql_database.db](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/database) | resource |
31+
| [postgresql_grant.user](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/grant) | resource |
32+
| [postgresql_grant.viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/grant) | resource |
33+
| [postgresql_role.db_owner](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role) | resource |
34+
| [postgresql_role.db_user](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role) | resource |
35+
| [postgresql_role.db_viewer](https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/role) | resource |
2136
| [aws_db_instance.shared](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/db_instance) | data source |
22-
| [aws_secretsmanager_random_password.db_password_init](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/secretsmanager_random_password) | data source |
37+
2338
## Inputs
2439

2540
| Name | Description | Type | Default | Required |
2641
|------|-------------|------|---------|:--------:|
27-
| <a name="input_db_name"></a> [db\_name](#input\_db\_name) | n/a | `string` | n/a | yes |
42+
| <a name="input_application_type"></a> [application\_type](#input\_application\_type) | n/a | `string` | n/a | yes |
2843
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
29-
| <a name="input_owner_name"></a> [owner\_name](#input\_owner\_name) | n/a | `string` | n/a | yes |
30-
| <a name="input_shared_configuration"></a> [shared\_configuration](#input\_shared\_configuration) | Configuration object from shared resources | <pre>object({<br> alb_arn = string<br> alb_https_listener_arn = string<br> cluster_id = string<br> cluster_name = string<br> task_execution_role_arn = string<br> db_identifier = string<br> vpc_id = string<br> public_subnet_ids = set(string)<br> })</pre> | n/a | yes |
31-
| <a name="input_user_name"></a> [user\_name](#input\_user\_name) | n/a | `string` | `""` | no |
32-
| <a name="input_viewer_name"></a> [viewer\_name](#input\_viewer\_name) | n/a | `string` | `""` | no |
44+
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | n/a | `string` | n/a | yes |
45+
3346
## Outputs
3447

3548
| Name | Description |
3649
|------|-------------|
3750
| <a name="output_database"></a> [database](#output\_database) | n/a |
3851
| <a name="output_host"></a> [host](#output\_host) | n/a |
39-
| <a name="output_owner"></a> [owner](#output\_owner) | n/a |
52+
| <a name="output_owner_password"></a> [owner\_password](#output\_owner\_password) | n/a |
4053
| <a name="output_owner_password_arn"></a> [owner\_password\_arn](#output\_owner\_password\_arn) | n/a |
54+
| <a name="output_owner_username"></a> [owner\_username](#output\_owner\_username) | n/a |
4155
| <a name="output_port"></a> [port](#output\_port) | n/a |
42-
| <a name="output_user"></a> [user](#output\_user) | n/a |
56+
| <a name="output_user_password"></a> [user\_password](#output\_user\_password) | n/a |
4357
| <a name="output_user_password_arn"></a> [user\_password\_arn](#output\_user\_password\_arn) | n/a |
44-
| <a name="output_viewer"></a> [viewer](#output\_viewer) | n/a |
58+
| <a name="output_user_username"></a> [user\_username](#output\_user\_username) | n/a |
59+
| <a name="output_viewer_password"></a> [viewer\_password](#output\_viewer\_password) | n/a |
4560
| <a name="output_viewer_password_arn"></a> [viewer\_password\_arn](#output\_viewer\_password\_arn) | n/a |
46-
## Providers
47-
48-
| Name | Version |
49-
|------|---------|
50-
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
51-
| <a name="provider_postgresql"></a> [postgresql](#provider\_postgresql) | ~> 1.21.0 |
52-
## Requirements
53-
54-
| Name | Version |
55-
|------|---------|
56-
| <a name="requirement_postgresql"></a> [postgresql](#requirement\_postgresql) | ~> 1.21.0 |
57-
58-
To automatically update this documentation, install terraform-docs on your local machine run the following:
59-
cd <directory of README location to update>
60-
terraform-docs -c .terraform.docs.yml .
61+
| <a name="output_viewer_username"></a> [viewer\_username](#output\_viewer\_username) | n/a |
6162
<!-- END_TF_DOCS -->

‎terraform/modules/dns-entry/README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
11+
12+
## Modules
13+
14+
No modules.
15+
16+
## Resources
17+
18+
| Name | Type |
19+
|------|------|
20+
| [aws_route53_record.www](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
21+
| [aws_lb.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lb) | data source |
22+
| [aws_route53_zone.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/route53_zone) | data source |
23+
24+
## Inputs
25+
26+
| Name | Description | Type | Default | Required |
27+
|------|-------------|------|---------|:--------:|
28+
| <a name="input_subdomain"></a> [subdomain](#input\_subdomain) | n/a | `string` | n/a | yes |
29+
| <a name="input_zone_id"></a> [zone\_id](#input\_zone\_id) | n/a | `string` | n/a | yes |
30+
31+
## Outputs
32+
33+
| Name | Description |
34+
|------|-------------|
35+
| <a name="output_full_dns_name"></a> [full\_dns\_name](#output\_full\_dns\_name) | n/a |
36+
<!-- END_TF_DOCS -->

‎terraform/modules/ecr/README.md‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,34 @@
11
<!-- BEGIN_TF_DOCS -->
2-
# ECR
2+
## Requirements
33

4-
Add description.
4+
No requirements.
55

6+
## Providers
67

8+
| Name | Version |
9+
|------|---------|
10+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
11+
12+
## Modules
13+
14+
No modules.
715

816
## Resources
917

1018
| Name | Type |
1119
|------|------|
1220
| [aws_ecr_repository.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_repository) | resource |
21+
1322
## Inputs
1423

1524
| Name | Description | Type | Default | Required |
1625
|------|-------------|------|---------|:--------:|
17-
| <a name="input_environment"></a> [environment](#input\_environment) | n/a | `string` | n/a | yes |
1826
| <a name="input_project_name"></a> [project\_name](#input\_project\_name) | The overall name of the project using this infrastructure; used to group related resources by | `string` | n/a | yes |
1927

20-
## Providers
21-
22-
| Name | Version |
23-
|------|---------|
24-
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
25-
28+
## Outputs
2629

27-
To automatically update this documentation, install terraform-docs on your local machine run the following:
28-
cd <directory of README location to update>
29-
terraform-docs -c .terraform.docs.yml .
30+
| Name | Description |
31+
|------|-------------|
32+
| <a name="output_arn"></a> [arn](#output\_arn) | n/a |
33+
| <a name="output_repository_url"></a> [repository\_url](#output\_repository\_url) | n/a |
3034
<!-- END_TF_DOCS -->

‎terraform/modules/legacy/README.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
No providers.
9+
10+
## Modules
11+
12+
No modules.
13+
14+
## Resources
15+
16+
No resources.
17+
18+
## Inputs
19+
20+
No inputs.
21+
22+
## Outputs
23+
24+
No outputs.
25+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)