You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GitHub workflow file for reference available here.
Despite using the config-file option, action defaults appear to cause unwanted overrides. From an action log from the repo I am testing with, you can clearly see the unwanted behaviour:
None of the modules/**/README.md files should have been created.
This is what should have happened, i.e. only the README.md file in the root folder should have been updated, according to the contents of the .terraform-docs.yml file in the root folder and those in the module/*/ subfolders:
Long story short: when using the config-file option, no defaults should be passed down to terraform-docs. For backward compatibility, one could perhaps add an ignore-defaults option.
Describe the bug
GitHub workflow file for reference available here.
Despite using the
config-file
option, action defaults appear to cause unwanted overrides. From an action log from the repo I am testing with, you can clearly see the unwanted behaviour:As .terraform-docs.yml already contains all the desired settings, none of the following defaults is desirable:
None of the modules/**/README.md files should have been created.
This is what should have happened, i.e. only the README.md file in the root folder should have been updated, according to the contents of the .terraform-docs.yml file in the root folder and those in the module/*/ subfolders:
That produces the correct results and is consistent with running
terraform-docs
v0.16.0 manually in the repo root:Long story short: when using the
config-file
option, no defaults should be passed down toterraform-docs
. For backward compatibility, one could perhaps add anignore-defaults
option.How can we reproduce it?
You can:
Environment information
This is running a GitHub action directly. See GitHub workflow file.
The text was updated successfully, but these errors were encountered: