chore: terraform-docs-system (#249)

* chore: use terraform-docs-system * chore: pin action * docs: terraform docs
trussworks · Jan 13, 2025 · d967a44 · d967a44
1 parent 574c760
commit d967a44
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/.github/workflows/validate.yml b/.github/workflows/validate.yml
@@ -10,4 +10,4 @@ on:
 
 jobs:
   validate-tf:
-    uses: trussworks/shared-actions/.github/workflows/validate-tf.yml@main
+    uses: trussworks/shared-actions/.github/workflows/validate-tf.yml@3cab03ab95045711da37ad6d63a93c666fc22398 # v0.0.2
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -22,7 +22,7 @@ repos:
   - repo: https://github.com/terraform-docs/terraform-docs
     rev: "v0.19.0"
     hooks:
-      - id: terraform-docs-go
+      - id: terraform-docs-system
 
   - repo: https://github.com/antonbabenko/pre-commit-terraform
     rev: v1.96.3

diff --git a/examples/simple/README.md b/examples/simple/README.md
@@ -2,26 +2,26 @@
 
 <!-- BEGIN_TF_DOCS -->
 
-
 ## Modules
 
-| Name | Source | Version |
-|------|--------|---------|
-| aws_cloudtrail | ../../ | n/a |
-| logs | trussworks/logs/aws | ~> 12 |
+| Name           | Source              | Version |
+| -------------- | ------------------- | ------- |
+| aws_cloudtrail | ../../              | n/a     |
+| logs           | trussworks/logs/aws | ~> 12   |
 
 ## Inputs
 
-| Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:--------:|
-| cloudwatch_log_group_name | n/a | `string` | n/a | yes |
-| logs_bucket | n/a | `string` | n/a | yes |
-| s3_key_prefix | n/a | `string` | n/a | yes |
-| trail_name | n/a | `string` | n/a | yes |
+| Name                      | Description | Type     | Default | Required |
+| ------------------------- | ----------- | -------- | ------- | :------: |
+| cloudwatch_log_group_name | n/a         | `string` | n/a     |   yes    |
+| logs_bucket               | n/a         | `string` | n/a     |   yes    |
+| s3_key_prefix             | n/a         | `string` | n/a     |   yes    |
+| trail_name                | n/a         | `string` | n/a     |   yes    |
 
 ## Outputs
 
-| Name | Description |
-|------|-------------|
+| Name           | Description    |
+| -------------- | -------------- |
 | cloudtrail_arn | CloudTrail ARN |
+
 <!-- END_TF_DOCS -->