Merge pull request #89 from mineiros-io/kassianh/feat/terradoc

feat: add terradoc

Author: mariux

.pre-commit-config.yaml

@@ -1,13 +1,13 @@
 repos:
   - repo: https://github.com/mineiros-io/pre-commit-hooks
-    rev: v0.2.3
+    rev: v0.3.1
     hooks:
       - id: terraform-fmt
       - id: terraform-validate
         exclude: ^examples|.terraform/
       - id: tflint
-      - id: gofmt
-      - id: goimports
       - id: golangci-lint
       - id: phony-targets
       - id: markdown-link-check
+        args: ['-p']   # When adding the -p flag, markdown-link-check will always with an exit code 0, even if dead links are found
+        verbose: true  # Forces the output of the hook to be printed even when the hook passes.

Makefile

@@ -108,6 +108,11 @@ help:
 	} \
 	{ lastLine = $$0 }' $(MAKEFILE_LIST)
 
+## Generate README.md with Terradoc
+.PHONY: terradoc
+terradoc:
+	$(call quiet-command,terradoc -o README.md README.tfdoc.hcl)
+
 # define helper functions
 DOCKER_FLAGS   += ${DOCKER_RUN_FLAGS}
 DOCKER_RUN_CMD  = docker run ${DOCKER_FLAGS} ${BUILD_TOOLS_DOCKER_IMAGE}