fix(test-module): support terraform-docs's output.file #1584
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Ignore this message. $ terraform-docs .
README.md updated successfully |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #1582
This pull request fixes a bug that a Module document README.md becomes empty by
terraform-docsif output.file is set.This pull request changes how to run
terraform-docsas the following.Run
terraform-docs .and output the result to a temporal file.If the output is empty, this meansoutput.fileis enabled.If the output isn't empty, this meansoutput.fileis disabled and the generated document is outputted to the temporal file, so copy the content of the temporal file to README.md.If README.md doesn't include
<!-- BEGIN_TF_DOCS -->, copy the content of the temporal file to README.md.