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
Requirements
Providers
Modules
No modules.
Resources
Inputs
Name |
Description |
Type |
Default |
Required |
subnet_ids |
A list of subnet ids to use |
list(string) |
n/a |
yes |
vpc_id |
The id of the vpc |
string |
n/a |
yes |
extra_environment |
List of additional environment variables |
list(object({ name = string value = string })) |
[] |
no |
extra_tags |
Additional tags |
map(string) |
{} |
no |
instance_count |
Number of instances to create |
number |
1 |
no |
instance_name |
Instance name prefix |
string |
"test-" |
no |
Outputs
Name |
Description |
vpc_id |
The Id of the VPC |
License
MIT License - Copyright (c) 2022 The terraform-docs Authors.