https://github.com/terraform-docs/tfdocs-gh-actions-example
Demo project to showcase terraform-docs gh-actions
https://github.com/terraform-docs/tfdocs-gh-actions-example
actions example gh-actions terraform terraform-docs
Last synced: about 2 months ago
JSON representation
Demo project to showcase terraform-docs gh-actions
- Host: GitHub
- URL: https://github.com/terraform-docs/tfdocs-gh-actions-example
- Owner: terraform-docs
- License: mit
- Created: 2021-07-21T20:27:22.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2022-01-26T22:39:58.000Z (over 4 years ago)
- Last Synced: 2025-07-06T22:39:39.595Z (12 months ago)
- Topics: actions, example, gh-actions, terraform, terraform-docs
- Language: HCL
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tfdocs-gh-actions
This is a demo project to show how to automatically generate documentations of
Terraform modules with [terraform-docs] using [terraform-docs/gh-actions].
## Prerequisites
- [Terraform](https://www.terraform.io) v0.12+
- [terraform-docs](https://github.com/terraform-docs/terraform-docs) v0.16+
- [terraform-docs/gh-actions](https://github.com/terraform-docs/gh-actions) v1.0+
## Requirements
| Name | Version |
|------|---------|
| [aws](#requirement\_aws) | ~> 2.20.0 |
| [consul](#requirement\_consul) | >= 2.4.0 |
## Providers
| Name | Version |
|------|---------|
| [aws](#provider\_aws) | ~> 2.20.0 |
| [consul](#provider\_consul) | >= 2.4.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [aws_acm_certificate.test-cert](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) | data source |
| [consul_key.test](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key) | data source |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [subnet\_ids](#input\_subnet\_ids) | A list of subnet ids to use | `list(string)` | n/a | yes |
| [vpc\_id](#input\_vpc\_id) | The id of the vpc | `string` | n/a | yes |
| [extra\_environment](#input\_extra\_environment) | List of additional environment variables |
list(object({
name = string
value = string
})) | `[]` | no |
| [extra\_tags](#input\_extra\_tags) | Additional tags | `map(string)` | `{}` | no |
| [instance\_count](#input\_instance\_count) | Number of instances to create | `number` | `1` | no |
| [instance\_name](#input\_instance\_name) | Instance name prefix | `string` | `"test-"` | no |
## Outputs
| Name | Description |
|------|-------------|
| [vpc\_id](#output\_vpc\_id) | The Id of the VPC |
[terraform-docs]: https://github.com/terraform-docs/terraform-docs
[terraform-docs/gh-actions]: https://github.com/terraform-docs/gh-actions
## License
MIT License - Copyright (c) 2022 The terraform-docs Authors.