Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate README using terraform-docs in not only modules but also service directories #1859

Closed
suzuki-shunsuke opened this issue Oct 4, 2024 · 0 comments · Fixed by #1878
Labels
enhancement New feature or request
Milestone

Comments

@suzuki-shunsuke
Copy link
Owner

suzuki-shunsuke commented Oct 4, 2024

Feature Overview

Generate README using terraform-docs in not only modules but also service directories.

https://suzuki-shunsuke.github.io/tfaction/docs/feature/module#generate-document

Why is the feature needed?

Generating README is useful for service directories as well.

Example Code

This feature requires terraform-docs, so to keep the compatibility this feature is disabled by default.

docs
  terraform-docs:
    enabled: true

tfaction.yaml

docs
  terraform-docs:
    enabled: true

Note

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant