github/pre-commit-opentofu
1
0
Fork 1
mirror of https://github.com/tofuutils/pre-commit-opentofu.git synced 2025-10-15 17:38:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Address requested changes

Browse source
This commit is contained in:
rothandrew 2018-12-14 16:16:42 -05:00
commit d3fe87daea
2 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -62,7 +62,7 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo
1. `terraform_docs` and `terraform_docs_without_aggregate_type_defaults` will insert/update documentation generated by [terraform-docs](https://github.com/segmentio/terraform-docs) between markers - `<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->` and `<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->` if they are present in `README.md`. Make sure that `terraform-docs` is installed.
1. `terraform_docs_replace` replaces the entire README.md rather than doing string replacement between markers. Put your additional documentation at the top of your `main.tf` for it to be pulled in. The optional `--dest` argument lets your change the name of the file that gets created/modified
1. `terraform_docs_replace` replaces the entire README.md rather than doing string replacement between markers. Put your additional documentation at the top of your `main.tf` for it to be pulled in. The optional `--dest` argument lets your change the name of the file that gets created/modified.
1. Example:
```yaml
@ -73,6 +73,12 @@ Check the [source file](https://github.com/antonbabenko/pre-commit-terraform/blo
1. It is possible to pass additional arguments to shell scripts when using `terraform_docs` and `terraform_docs_without_aggregate_type_defaults`. Send pull-request with the new hook if there is something missing.
## Notes for developers
1. Python hooks are supported now too. All you have to do is:
1. add a line to the `console_sripts` array in `entry_points` in `setup.py`
1. Put your python script in the `pre_commit_hooks` folder
Enjoy the clean and documented code!
## Authors

3
setup.py
View file

@ -8,8 +8,7 @@ setup(
url='https://github.com/antonbabenko/pre-commit-terraform',
version_format='{tag}+{gitsha}',
author='Andrew Roth',
author_email='roth.andy@gmail.com',
author='Contributors',
classifiers=[
'License :: OSI Approved :: MIT License',