Skip to content
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

Added terraform-docs integration #13

Merged
merged 28 commits into from
May 16, 2018
Merged

Added terraform-docs integration #13

merged 28 commits into from
May 16, 2018

Conversation

antonbabenko
Copy link
Owner

@antonbabenko antonbabenko commented May 16, 2018

Added terraform_docs hook (kudos @gabel0287, perl version didn't work for me).

Follow these steps:

  1. brew install terraform-docs or similar
  2. Add <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK --> and <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> somewhere in README.md
  3. Add - id: terraform_docs to .pre-commit-config.yaml
  4. git commit and get your Terraform documentation autogenerated for you when you commit :)

Closes #12

@antonbabenko antonbabenko merged commit 97a6686 into master May 16, 2018
@antonbabenko antonbabenko deleted the pr/12 branch May 16, 2018 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants