| config-file | Name of terraform-docs config file. To enable, provide the file name (e.g. `.terraform-docs.yml`) | no | disabled |
| working-dir | Comma separated list of directories to generate docs for (ignored if `atlantis-file` or `find-dir` is set) | no | . |
| atlantis-file | Name of Atlantis file to extract list of directories by parsing it. To enable, provide the file name (e.g. `atlantis.yaml`) | no | disabled |
| find-dir | Name of root directory to extract list of directories by running `find ./find_dir -name *.tf` (ignored if `atlantis-file` is set) | no | disabled |
| recursive | If true it will update submodules recursively | no | false |
| recursive-path | Submodules path to recursively update | no | modules |
| output-format | terraform-docs format to generate content (see [all formats](https://github.com/terraform-docs/terraform-docs/blob/master/docs/FORMATS_GUIDE.md)) (ignored if `config-file` is set) | no | markdown table |
| output-method | Method should be one of `replace`, `inject`, or `print`. Set as an empty string if `output.mode` and `output.file` are defined in config-file | no | inject |
| output-file | File in module directory where the docs should be placed | no | README.md |
| template | When provided will be used as the template if/when the `output-file` does not exist. Set as an empty string if `output.template` is defined in config-file | no | <!-- BEGIN_TF_DOCS -->
{{ .Content }}
<!-- END_TF_DOCS --> |
| args | Additional arguments to pass to the command (see [full documentation](https://github.com/terraform-docs/terraform-docs/tree/master/docs)) | no | "" |
| indention | Indention level of Markdown sections [1, 2, 3, 4, 5] | no | 2 |
| git-push | If true it will commit and push the changes | no | false |
| git-push-user-name | If empty the name of the GitHub Actions bot will be used (i.e. `github-actions[bot]`) | no | "" |
| git-push-user-email | If empty the no-reply email of the GitHub Actions bot will be used (i.e. `github-actions[bot]@users.noreply.github.com`) | no | "" |
| git-commit-message | Commit message | no | terraform-docs: automated action |
| git-push-sign-off | If true it will sign-off commit | no | false |
| git-sub-dir | Subdirectory that terraform code is checked out into | no | "" |
| fail-on-diff | Fail the job if there is any diff found between the generated output and existing file (ignored if `git-push` is set) | no | false |