Skip to content

feat: auto-generate terraform docs on .tf file changes#90

Open
Copilot wants to merge 2 commits intomainfrom
copilot/implement-auto-tfdocs-on-changes
Open

feat: auto-generate terraform docs on .tf file changes#90
Copilot wants to merge 2 commits intomainfrom
copilot/implement-auto-tfdocs-on-changes

Conversation

Copy link
Contributor

Copilot AI commented Mar 17, 2026

Terraform module READMEs were only updated via pre-commit hooks locally, with no CI enforcement or automation on push/PR.

Changes

  • New workflow .github/workflows/terraform-docs.yml:
    • Triggers on pull_request and push to main scoped to **/*.tf path changes
    • Runs terraform-docs/gh-actions@v1 in recursive mode across the entire repo
    • Uses inject output method — updates only <!-- BEGIN_TF_DOCS -->…<!-- END_TF_DOCS --> blocks, preserving surrounding custom content
    • Passes --lockfile=false to match existing pre-commit configuration
    • Auto-commits and pushes updated README.md files back to the branch as github-actions[bot]
    • Minimal permissions: contents: write + pull-requests: write at job scope only, consistent with other workflows in the repo
Original prompt

This section details on the original issue you should resolve

<issue_title>implement auto tfdocs on changes</issue_title>
<issue_description>Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.
</issue_description>

Comments on the Issue (you are @copilot in this section)


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

…changes

Co-authored-by: fredleger <2778741+fredleger@users.noreply.github.com>
Copilot AI changed the title [WIP] Implement auto tfdocs on changes feat: auto-generate terraform docs on .tf file changes Mar 17, 2026
Copilot AI requested a review from fredleger March 17, 2026 21:10
@fredleger fredleger marked this pull request as ready for review March 17, 2026 21:23
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.

implement auto tfdocs on changes

2 participants