New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use terraform-docs native saving to file #179
Comments
Thanks a lot for the update! That would be really nice if we can remove sed/awk/perl hack which was there since pre-0.12 times :) I don't have time for this work myself but maybe someone from the community can make a PR. |
Does it make sense to deprecate Why not just support native |
This issue has been automatically marked as stale because it has been open 30 days |
This fix would be very helpful to me! 😸 |
Any chance to get this fixed and remove all those crazy dependencies like perl? <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
README.md updated successfully
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> While when I run Just for the reference, my formatter: "markdown table"
output:
file: README.md
mode: inject
template: |-
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
{{ .Content }}
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> Would be also great to get rid of custom |
Feel free to implement it and send PR, your help will be much appreciated. |
@dzavalkin-scayle I'm coming across this behaviour too - there's some kind of conflict between I've worked around this by adding an argument into my hook which restores the previous behaviour of making
Maybe this helps you too? In the long term I agree that the entire wrapper should just be simplified and require a recent version of edit: this may not work with older hooks, I had a repo using |
In terraform-docs
v0.12.0
, we've added ability to insert generated output directly into a target file (terraform-docs/terraform-docs#286)! This can replace all the sed/awk/perl and drastically simplify the process to the point of only executing:terraform-docs --output-file README.md --output-mode inject .
Check out all the available option to configure this.
We've just cut a
v0.12.0-beta.1
for folks to start experimenting. Please feel free to start using and file any issues or feedback.The text was updated successfully, but these errors were encountered: