Disableable running terraform-docs in test-module

[mizukmb]

tfaction version

v1.17.0

Overview

I want to control the terraform-docs execution for tfaction/test-module via its configuration file (tfaction.yaml or tfaction_module.yaml), just as it works for tfaction/test.

How to reproduce

tfaction-root.yaml

terraform_docs:
  enabled: false

tfaction.yaml

GitHub Actions Workflow

- uses: suzuki-shunsuke/tfaction/test-module@fe01abc967d9c7a9889abbb8502e2947a1dfece3 # v1.17.0

Expected behaviour

Setting terraform_docs.enabled: (true|false) in tfaction.yaml or tfaction_module.yaml allows you to control the terraform-docs execution when tfaction/test-module runs.

Actual behaviour

terraform-docs is always executed, ignoring the terraform_docs.enabled setting in tfaction.yaml and tfaction_module.yaml.

Note

No response

[suzuki-shunsuke]

Hmm. It's a bit difficult decision.
The simplest fix is to add if here.

tfaction/test-module/action.yaml

Lines 59 to 60 in f372906

	- uses: suzuki-shunsuke/tfaction/terraform-docs@main
	with:

But this is a breaking change.
The document of Modules is more valuable than the document of root modules, so some people would want to generate the document of Modules while stopping generating the document of root modules.

Another idea is to add the setting for modules.

e.g.

module:
  terraform_docs:
    enabled: false

[mizukmb]

Thank you for your reply!

The document of Modules is more valuable than the document of root modules

I agree with this idea. I believe that preparing documentation for Modules is important, and I don't see any problem with enabling terraform-docs by default.

The reason I created this issue is that I've recently had good results generating module READMEs with vibe coding. I thought it would be possible to create a good documentation even without terraform-docs.

Another idea is to add the setting for modules.

I think separating the settings for root modules and Modules is a great idea!