{"repo":"terraform-docs/gh-actions","free":true,"listed":false,"github":"https://github.com/terraform-docs/gh-actions","clone":"git clone https://github.com/terraform-docs/gh-actions.git","description":"A Github action for generating Terraform module documentation using terraform-docs and gomplate","language":"Shell","stars":188,"topics":["terraform","terraform-docs","actions","github-actions"],"license":"Apache-2.0","category":"deployment-docker-iac","readme_excerpt":"terraform-docs GitHub Actions Generate Terraform module documentation in pull requests. In addition to statically defined directory modules, this module can search specific subfolders or parse atlantis.yaml for module identification and doc generation. This action has the ability to auto commit docs to an open PR or after a push to a specific branch. Version v1.4.1 (uses [terraform-docs] v0.20.0, which is supported and tested on Terraform version 0.11+ and 0.12+ but may work for others.) Upgrade v0 to v1 Release v1 contains following breaking changes: - default value of output-file has been changed to README.md - default value of template has been changed to Usage To use terraform-docs github action, configure a YAML workflow file, e.g. .github/workflows/documentation.yml , with the following: NOTE: If output-file (default README.md) already exists it will need to be updated, with the block delimeters and , where the generated markdown will be injected. Otherwise the generated content will be appended at the end of the file. --- NOTE: If output-file (default README.md) doesn't exist it will created and the content will be saved into it. --- Configuration Inputs Name Description Default Required ------ ------------- --------- ---------- args Additional arguments to pass to the command (see full documentation) \"\" false atlantis-file Name of Atlantis file to extract list of directories by parsing it. To enable, provide the file name (e.g. atlantis.yaml ) disabled false config-fi","default_branch":null,"files":null,"tree":[],"storefront":"/r/terraform-docs","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/terraform-docs/gh-actions/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}