mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 04:48:33 +07:00
1168e12b20
Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Add note on regenerating docs manually with pre-commit Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Fix documentation line length Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Fix pre-commit link Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Add YAML three dashes Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Use https protocol in pre-commit example Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Add pre-commit system hook, and some comments Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Sort how-to.md links Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Revert "Sort how-to.md links" This reverts commit e04fa9f4819278de53b869ebbc1a2a59fa662f6d. Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Sort how-to.md links by order of first appearance Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Add whitespace to .pre-commit-hooks.yaml Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Fix pre-commit hooks -> config Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com> Fix pre-commit example to use go hook Signed-off-by: Tom Pansino <2768420+tpansino@users.noreply.github.com>
32 lines
969 B
YAML
32 lines
969 B
YAML
---
|
|
# Build and run the Go binary from the repo
|
|
# REQUIRES: Go v1.16+ installed
|
|
- id: terraform-docs-go
|
|
name: terraform-docs
|
|
description: Generate documentation for Terraform modules (via Go binary)
|
|
language: golang
|
|
entry: terraform-docs
|
|
pass_filenames: false
|
|
types: [terraform]
|
|
|
|
# Build and run `terraform-docs` assuming it was installed manually
|
|
# or via package manager
|
|
# REQUIRES: terraform-docs to be installed and on the $PATH
|
|
- id: terraform-docs-system
|
|
name: terraform-docs
|
|
description: Generate documentation for Terraform modules (via locally-installed CLI)
|
|
language: system
|
|
entry: terraform-docs
|
|
pass_filenames: false
|
|
types: [terraform]
|
|
|
|
# Builds and runs the Docker image from the repo
|
|
# REQUIRES: Docker installed
|
|
- id: terraform-docs-docker
|
|
name: terraform-docs
|
|
description: Generate documentation for Terraform modules (via Docker build)
|
|
language: docker
|
|
entry: terraform-docs
|
|
pass_filenames: false
|
|
types: [terraform]
|