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

feat(test): update README by terraform-docs #1878

Merged
merged 5 commits into from
Oct 8, 2024

Conversation

suzuki-shunsuke
Copy link
Owner

@suzuki-shunsuke suzuki-shunsuke commented Oct 7, 2024

Close #1859

By default, this feature is disabled.

tfaction-root.yaml:

terraform_docs:
  enabled: true

tfaction.yaml:

terraform_docs:
  enabled: true

terraform-docs configuration

tfaction searches a configuration file:

  1. .terraform-docs.ya?ml in service directory
  2. .config/.terraform-docs.ya?ml in service directory
  3. .terraform-docs.ya?ml in the repository root directory
  4. .config/.terraform-docs.ya?ml in the repository root directory

https://terraform-docs.io/user-guide/configuration/

@suzuki-shunsuke suzuki-shunsuke added the enhancement New feature or request label Oct 7, 2024
@suzuki-shunsuke
Copy link
Owner Author

image

--

image

@suzuki-shunsuke suzuki-shunsuke added this to the v1.7.1 milestone Oct 8, 2024
@suzuki-shunsuke suzuki-shunsuke merged commit 1fa0c40 into main Oct 8, 2024
12 checks passed
@suzuki-shunsuke suzuki-shunsuke deleted the feat-terraform-docs branch October 8, 2024 03:30
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 this pull request may close these issues.

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