modules README.md is always overwritten

[rochana-atapattu]

modules README.md is always overwritten

[rochana-atapattu]

also i think you need to add pull_request_targe here

[suzuki-shunsuke]

Thank you for your feedback.
I didn't know the output config.
But I think you can use header-from and footer-from instead of inject mode.

https://github.com/suzuki-shunsuke/tfaction-example/blob/main/templates/module-hello/.terraform-docs.yml

[suzuki-shunsuke]

also i think you need to add pull_request_targe here

Yeah, that's right. Thank you for pointing it out.

[rochana-atapattu]

Thank you for your feedback. I didn't know the output config. But I think you can use header-from and footer-from instead of inject mode.

https://github.com/suzuki-shunsuke/tfaction-example/blob/main/templates/module-hello/.terraform-docs.yml

yes but we can use headers and footers to add more general information to the README which will give more flexibilty to the user
we can also do

github-comment exec \
    -config "${GITHUB_ACTION_PATH}/github-comment.yaml" \
    -var "tfaction_target:${TFACTION_TARGET}" \
   -- terraform-docs --output-file README.md .

which will give us the same results without overwritting the README
--output-file README.md override the output.file option in .terraform-docs.yml
and default output mode is inject

[suzuki-shunsuke]

also i think you need to add pull_request_targe here

• #1583

[suzuki-shunsuke]

📝 --output-file was added at terraform-docs v0.12.0.

https://github.com/terraform-docs/terraform-docs/releases/tag/v0.12.0

The release date is Mar 23, 2021, so there is no problem.

[suzuki-shunsuke]

Now test-module runs terraform-docs as the following.

tfaction/test-module/action.yaml

Line 63 in 8e6060b

-- terraform-docs . > README.md

terraform-docs . > README.md

If output is set as the following, README.md becomes empty.

output:
  file: README.md
  mode: inject

$ terraform-docs . > README.md
$ cat README.md 
Error: file content is empty

On the other hand, terraform-docs --output-file README.md . works well.

$ terraform-docs --output-file README.md .

But if the comment <!-- BEGIN_TF_DOCS --> isn't set, the command fails.

$ terraform-docs --output-file README.md .
Error: begin comment is missing

So this is a breaking change.

We can check if the comment exists, and if they don't exist we can run terraform-docs . > README.md without --output-file option.
This keeps the compatibility, but I'm not sure if it's good.

[suzuki-shunsuke]

1. Check .terraform-docs.yml if output.file is set
2. If output.file is set, tfaction runs terraform-docs .
3. Otherwise tfaction runs terraform-docs . > README (Redirect the stdout to README.md)

[suzuki-shunsuke]

• #1584

[suzuki-shunsuke]

v1.2.3 is out 🎉
https://github.com/suzuki-shunsuke/tfaction/releases/tag/v1.2.3