Skip to content

ci: generate terraform-docs for example READMEs - #3

Merged
EladBrosh merged 1 commit into
mainfrom
ci/example-docs
Jul 28, 2026
Merged

EladBrosh merged 1 commit into
mainfrom
ci/example-docs

Conversation

@EladBrosh

Copy link
Copy Markdown
Contributor

Summary

  • Add a Terraform Docs CI check for examples/, mirroring the existing check for modules/
  • Populate examples/gcp-audit-logs/README.md with a usage walkthrough and generated Requirements/Providers/Modules/Resources/Inputs/Outputs section

Test plan

  • terraform fmt -check -recursive .
  • terraform-docs re-run against both modules/gcp-audit-logs and examples/gcp-audit-logs — idempotent, no diff
  • CI green

Add a Terraform Docs check for examples/, mirroring the existing
modules/ check, and populate examples/gcp-audit-logs/README.md with a
usage walkthrough and generated Requirements/Providers/Modules/
Resources/Inputs/Outputs section.
@EladBrosh
EladBrosh merged commit f70cfad into main Jul 28, 2026
10 checks passed
@EladBrosh
EladBrosh deleted the ci/example-docs branch July 28, 2026 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants