Add hook to create readme #12
Closed
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
terraform_docs.sh
Outdated
| path_uniq="${path_uniq//__REPLACED__SPACE__/ }" | ||
|
|
||
| pushd "$path_uniq" > /dev/null | ||
| terraform-docs md ./ > README.md |
There was a problem hiding this comment.
This will overwrite the whole README.md which is not what everyone wants.
I think we should make some things configurable via pre-commit arguments:
- Filename to create (by default,
README.md) - Beginning and end markers where terraform-docs content should be placed between (by default, invisible blocks like
<!-- BEGINNING OF TERRAFORM-DOCS HOOK -->and<!-- END OF TERRAFORM-DOCS HOOK -->). If markers were not found - replace the whole file.
What do you think?
There was a problem hiding this comment.
Great idea! I'll update the PR.
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.
No description provided.