{"id":28556725,"url":"https://github.com/terraform-docs/tfdocs-gh-actions-example","last_synced_at":"2026-04-28T01:33:21.353Z","repository":{"id":45061228,"uuid":"388237702","full_name":"terraform-docs/tfdocs-gh-actions-example","owner":"terraform-docs","description":"Demo project to showcase terraform-docs gh-actions","archived":false,"fork":false,"pushed_at":"2022-01-26T22:39:58.000Z","size":5,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-06T22:39:39.595Z","etag":null,"topics":["actions","example","gh-actions","terraform","terraform-docs"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/terraform-docs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-07-21T20:27:22.000Z","updated_at":"2024-10-03T05:59:03.000Z","dependencies_parsed_at":"2022-09-05T05:00:58.055Z","dependency_job_id":null,"html_url":"https://github.com/terraform-docs/tfdocs-gh-actions-example","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/terraform-docs/tfdocs-gh-actions-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-docs%2Ftfdocs-gh-actions-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-docs%2Ftfdocs-gh-actions-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-docs%2Ftfdocs-gh-actions-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-docs%2Ftfdocs-gh-actions-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/terraform-docs","download_url":"https://codeload.github.com/terraform-docs/tfdocs-gh-actions-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/terraform-docs%2Ftfdocs-gh-actions-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32362781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-27T20:07:02.737Z","status":"ssl_error","status_checked_at":"2026-04-27T20:07:00.910Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","example","gh-actions","terraform","terraform-docs"],"created_at":"2025-06-10T07:07:53.331Z","updated_at":"2026-04-28T01:33:21.341Z","avatar_url":"https://github.com/terraform-docs.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tfdocs-gh-actions\n\nThis is a demo project to show how to automatically generate documentations of\nTerraform modules with [terraform-docs] using [terraform-docs/gh-actions].\n\n\u003c!-- BEGIN_TF_DOCS --\u003e\n## Prerequisites\n\n- [Terraform](https://www.terraform.io) v0.12+\n- [terraform-docs](https://github.com/terraform-docs/terraform-docs) v0.16+\n- [terraform-docs/gh-actions](https://github.com/terraform-docs/gh-actions) v1.0+\n\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | ~\u003e 2.20.0 |\n| \u003ca name=\"requirement_consul\"\u003e\u003c/a\u003e [consul](#requirement\\_consul) | \u003e= 2.4.0 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | ~\u003e 2.20.0 |\n| \u003ca name=\"provider_consul\"\u003e\u003c/a\u003e [consul](#provider\\_consul) | \u003e= 2.4.0 |\n\n## Modules\n\nNo modules.\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_acm_certificate.test-cert](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) | data source |\n| [consul_key.test](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_subnet_ids\"\u003e\u003c/a\u003e [subnet\\_ids](#input\\_subnet\\_ids) | A list of subnet ids to use | `list(string)` | n/a | yes |\n| \u003ca name=\"input_vpc_id\"\u003e\u003c/a\u003e [vpc\\_id](#input\\_vpc\\_id) | The id of the vpc | `string` | n/a | yes |\n| \u003ca name=\"input_extra_environment\"\u003e\u003c/a\u003e [extra\\_environment](#input\\_extra\\_environment) | List of additional environment variables | \u003cpre\u003elist(object({\u003cbr\u003e    name  = string\u003cbr\u003e    value = string\u003cbr\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_extra_tags\"\u003e\u003c/a\u003e [extra\\_tags](#input\\_extra\\_tags) | Additional tags | `map(string)` | `{}` | no |\n| \u003ca name=\"input_instance_count\"\u003e\u003c/a\u003e [instance\\_count](#input\\_instance\\_count) | Number of instances to create | `number` | `1` | no |\n| \u003ca name=\"input_instance_name\"\u003e\u003c/a\u003e [instance\\_name](#input\\_instance\\_name) | Instance name prefix | `string` | `\"test-\"` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_vpc_id\"\u003e\u003c/a\u003e [vpc\\_id](#output\\_vpc\\_id) | The Id of the VPC |\n\u003c!-- END_TF_DOCS --\u003e\n\n[terraform-docs]: https://github.com/terraform-docs/terraform-docs\n[terraform-docs/gh-actions]: https://github.com/terraform-docs/gh-actions\n\n\u003c!-- DO NOT EDIT! auto-generated by terraform-docs. --\u003e\n\n## License\n\nMIT License - Copyright (c) 2022 The terraform-docs Authors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraform-docs%2Ftfdocs-gh-actions-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fterraform-docs%2Ftfdocs-gh-actions-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fterraform-docs%2Ftfdocs-gh-actions-example/lists"}