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

Add instuction to contributers for pre-commit #46

Closed
npalm opened this issue Jun 30, 2020 · 2 comments
Closed

Add instuction to contributers for pre-commit #46

npalm opened this issue Jun 30, 2020 · 2 comments

Comments

@npalm
Copy link
Member

npalm commented Jun 30, 2020

Seems no instructions / directions are documented for pre commit hooks.

@axel3rd
Copy link
Contributor

axel3rd commented Sep 30, 2021

The Submitting a Merge Request section is clear (Installing terraform-docs & tflint is quite easy).

The pre-commit run --all-files is simple to use to check manually before or after some bug/feature fix.

Perhaps one attention about Terraform docs phase, it changes Markdown content adding many links like (Sample from git diff):

 ## Modules

 | Name | Source | Version |
 |------|--------|---------|
-| runner_binaries | ./modules/runner-binaries-syncer |  |
-| runners | ./modules/runners |  |
-| ssm | ./modules/ssm |  |
-| webhook | ./modules/webhook |  |
+| <a name="module_runner_binaries"></a> [runner\_binaries](#module\_runner\_binaries) | ./modules/runner-binaries-syncer | n/a |
+| <a name="module_runners"></a> [runners](#module\_runners) | ./modules/runners | n/a |
+| <a name="module_ssm"></a> [ssm](#module\_ssm) | ./modules/ssm | n/a |
+| <a name="module_webhook"></a> [webhook](#module\_webhook) | ./modules/webhook | n/a |

I don't know if it is really wanted, perhaps depends of terraform-docs version (v0.15.0 is used).

@npalm
Copy link
Member Author

npalm commented Dec 2, 2021

Instructions are available

@npalm npalm closed this as completed Dec 2, 2021
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

No branches or pull requests

2 participants