Skip to content
This repository was archived by the owner on Jul 20, 2024. It is now read-only.

Commit 10b958b

Browse files
Fix terraform docs (#43)
* Fix terraform docs * Test change * Test change * Test * Test * Update terraform.yaml * terraform-docs: automated action --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 1c8ffeb commit 10b958b

File tree

3 files changed

+35
-9
lines changed

3 files changed

+35
-9
lines changed

‎.github/workflows/terraform.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,14 @@ jobs:
1818
- uses: actions/checkout@v2
1919
- uses: hashicorp/setup-terraform@v1
2020
- run: make
21+
22+
docs:
23+
runs-on: ubuntu-latest
24+
timeout-minutes: 10
25+
steps:
26+
- uses: actions/checkout@v2
27+
with:
28+
ref: ${{ github.event.pull_request.head.ref }}
29+
- uses: terraform-docs/gh-actions@v1
30+
with:
31+
git-push: 'true'

‎Makefile

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
all: check README.md
2-
31
.PHONY: check
42
check:
53
terraform fmt -check=true -diff=true
64
terraform init
75
AWS_REGION=us-east-1 terraform validate
86
make -C example check
9-
10-
README.md: variables.tf outputs.tf
11-
sed -e '/^<!--terraform-docs-->/q' $@ > $@.tmp
12-
terraform-docs md . >> $@.tmp
13-
mv $@.tmp $@

‎README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Successfully moved 1 object(s).
150150
This is an open source software. Feel free to open issues and pull requests.
151151

152152

153-
<!--terraform-docs-->
153+
<!-- BEGIN_TF_DOCS -->
154154
## Requirements
155155

156156
No requirements.
@@ -159,7 +159,28 @@ No requirements.
159159

160160
| Name | Version |
161161
|------|---------|
162-
| aws | n/a |
162+
| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
163+
164+
## Modules
165+
166+
No modules.
167+
168+
## Resources
169+
170+
| Name | Type |
171+
|------|------|
172+
| [aws_autoscaling_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/autoscaling_group) | resource |
173+
| [aws_iam_instance_profile.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |
174+
| [aws_iam_role.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
175+
| [aws_iam_role_policy.eni](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy) | resource |
176+
| [aws_iam_role_policy_attachment.ssm](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
177+
| [aws_launch_template.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template) | resource |
178+
| [aws_network_interface.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/network_interface) | resource |
179+
| [aws_route.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route) | resource |
180+
| [aws_security_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
181+
| [aws_security_group_rule.egress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
182+
| [aws_security_group_rule.ingress_any](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
183+
| [aws_ami.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |
163184

164185
## Inputs
165186

@@ -188,3 +209,4 @@ No requirements.
188209
| <a name="output_eni_private_ip"></a> [eni\_private\_ip](#output\_eni\_private\_ip) | Private IP of the ENI for the NAT instance |
189210
| <a name="output_iam_role_name"></a> [iam\_role\_name](#output\_iam\_role\_name) | Name of the IAM role for the NAT instance |
190211
| <a name="output_sg_id"></a> [sg\_id](#output\_sg\_id) | ID of the security group of the NAT instance |
212+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)