friendsofterraform/tfdocs-extras

Generate Terraform object() type documentation in README.md files using tfdocs-extras

Trust Signals

name	description	required	default
directories	Newline-separated list of Terraform module directories to process. Each directory will be checked for a README.md containing TFDOCS_EXTRAS_START/TFDOCS_EXTRAS_END markers and processed if found.	yes	—
version	Version of tfdocs-extras to download (e.g. "v0.1.0"). Defaults to the latest release.	no	latest
token	GitHub token used to download the release binary, avoid API rate limits, and authenticate git operations. Required if commit is true and actions/checkout is used with persist-credentials: false (recommended for security). Defaults to github.token if not provided.	no	""
commit	Commit any README.md changes after processing.	no	false
commit_message	Commit message to use when commit is true.	no	chore: update tfdocs-extras documentation
commit_author	Author identity for the commit in "Name <email>" format. Only used when commit is true.	no	github-actions[bot] <github-actions[bot]@users.noreply.github.com>
commit_branch	Branch to push the commit to. Only used when commit is true. Defaults to the current branch.	no	""
fail_on_diff	Exit with a non-zero status if any README.md files were modified. Mutually exclusive with commit.	no	false
json_output_file	Path to write the aggregated JSON output. If not specified, JSON is only written to the step output (subject to size limits).	no	""

name	description
result	JSON array of module manifests, one object per processed directory.