From d3fe87daeac07704ae27e02e87df719dd7c9ac9f Mon Sep 17 00:00:00 2001 From: rothandrew Date: Fri, 14 Dec 2018 16:16:42 -0500 Subject: [PATCH] Address requested changes --- README.md | 8 +++++++- setup.py | 3 +-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 84ed481..1bceb95 100644 --- a/README.md +++ b/README.md @@ -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 - `` and `` 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 diff --git a/setup.py b/setup.py index 246de8c..4c2b476 100644 --- a/setup.py +++ b/setup.py @@ -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',