tarak/Setup terraform-docs
Sets up terraform-docs CLI in your GitHub Actions workflow
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| terraform_docs_version | terraform-docs version to install | no | latest |
| architecture | Target architecture for Node to use. Examples: x86, x64. Will use system architecture by default. | — | — |
| github_token | GitHub token - used when getting the latest version of terraform-docs | no | ${{ github.server_url == 'https://github.com' && github.token || '' }} |
| terraform_docs_wrapper | Installs a wrapper script to wrap subsequent calls to `terraform-docs` and expose `stdout`, `stderr`, and `exitcode` outputs | no | false |
Outputs
| name | description |
|---|---|
| stdout | The output (stdout) produced by the terraform-docs command. Only available if `terraform_docs_wrapper` is set to `true`. |
| stderr | The error output (stderr) produced by the terraform-docs command. Only available if `terraform_docs_wrapper` is set to `true`. |
| exitcode | The exit code produced by the terraform-docs command. Only available if `terraform_docs_wrapper` is set to `true`. |