actions-marketplace-validations/terraform-docs-archived

A Github action for generating terraform module documentation using terraform-docs and gomplate.

Trust Signals

name	description	required	default
tf_docs_working_dir	Directories of terraform modules to generate docs for seperated by commas (conflicts with atlantis/find dirs)	no	.
tf_docs_atlantis_file	Generate directories by parsing an atlantis formatted yaml to enable provide the file name to parse (eg atlantis.yaml)	no	disabled
tf_docs_find_dir	Generate directories by running find ./tf_docs_find_dir -name *.tf	no	disabled
tf_docs_output_file	File in module directory where the docs should be placed	no	USAGE.md
tf_docs_content_type	Generate document or table	no	table
tf_docs_indention	Indention level of Markdown sections [1, 2, 3, 4, 5]	no	2
tf_docs_args	Additional args to pass to the command see https://github.com/segmentio/terraform-docs/tree/master/docs	no	""
tf_docs_output_method	Method should be one of (replace/inject/print) where replace will replace the tf_docs_output_file, inject will inject the content between start and close delims and print will just print the output	no	inject
tf_docs_git_push	If true it will commit and push the changes	no	false
tf_docs_git_commit_message	Commit message	no	terraform-docs: automated action
tf_docs_template	When provided will be used as the template if/when the OUTPUT_FILE does not exist	no	# Usage <!--- BEGIN_TF_DOCS ---> <!--- END_TF_DOCS --->

name	description
num_changed	Number of files changed