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 pre-commit hook to autogenerate terraform-docs #68

Merged
merged 1 commit into from
May 16, 2018

Conversation

antonbabenko
Copy link
Member

@antonbabenko antonbabenko commented May 16, 2018

@brandoconnor I am adding the same autogenerated documentation using pre-commit hooks to all terraform-aws-modules.

Feel free to adjust it if you want.

Copy link
Contributor

@brandonjbjelland brandonjbjelland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this! LGTM

I'd used the terraform-docs project before but mostly thought it was useful because we had no registry that brought the inputs and outputs together. I suppose it doesn't hurt to have a tool generate them in the readme also.

@antonbabenko
Copy link
Member Author

I agree. I was asked for this multiple times when people don't want to jump between their editor and registry website. Merge and release as you normally do (I don't know your procedure). :)

Have a great day!

@brandonjbjelland
Copy link
Contributor

Ahh good point. If people are asking for it in your other modules, it's only a matter of time here.

My process:

[x] change fits project vision
[x] linters happy
[x] tests pass

Squash and merge to be queued for the next release! 😄 👍

@brandonjbjelland brandonjbjelland merged commit 669f188 into master May 16, 2018
@brandonjbjelland brandonjbjelland deleted the pre-commit-terraform-docs branch May 16, 2018 20:05
@github-actions
Copy link

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants