Add sysutils/terraform-docs: Generate documentation from Terraform modules

A utility to generate documentation from Terraform modules in various output
formats.

  terraform-docs asciidoc ./my-terraform-module          # asciidoc table
  terraform-docs asciidoc table ./my-terraform-module    # asciidoc table
  terraform-docs asciidoc document ./my-terraform-module # asciidoc document
  terraform-docs json ./my-terraform-module              # json
  terraform-docs markdown ./my-terraform-module          # markdown table
  terraform-docs markdown table ./my-terraform-module    # markdown table
  terraform-docs markdown document ./my-terraform-module # markdown document
  terraform-docs pretty ./my-terraform-module            # colorized pretty
  terraform-docs tfvars hcl ./my-terraform-module        # hcl format of
                                                           terraform.tfvars
  terraform-docs tfvars json ./my-terraform-module       # json format of
                                                           terraform.tfvars
  terraform-docs toml ./my-terraform-module              # toml
  terraform-docs xml ./my-terraform-module               # xml
  terraform-docs yaml ./my-terraform-module              # yaml

WWW: https://github.com/terraform-docs/terraform-docs

PR:		249903
Submitted by:	Gabriel Dutra <0xdutra@gmail.com>
This commit is contained in:
Danilo G. Baio 2020-10-02 21:26:37 +00:00
parent c78cb6afdb
commit f766f69f12
Notes: svn2git 2021-03-31 03:12:20 +00:00
svn path=/head/; revision=551233
4 changed files with 107 additions and 0 deletions

View File

@ -1298,6 +1298,7 @@
SUBDIR += tealdeer
SUBDIR += tenshi
SUBDIR += terraform
SUBDIR += terraform-docs
SUBDIR += terraform-provider-gridscale
SUBDIR += terraform-provider-vultr
SUBDIR += terragrunt

View File

@ -0,0 +1,43 @@
# $FreeBSD$
PORTNAME= terraform-docs
PORTVERSION= 0.10.1
DISTVERSIONPREFIX= v
CATEGORIES= sysutils textproc
MAINTAINER= 0xdutra@gmail.com
COMMENT= Generate documentation from Terraform modules
LICENSE= MIT
LICENSE_FILE= ${WRKSRC}/LICENSE
USES= go:modules
USE_GITHUB= yes
GH_ACCOUNT= terraform-docs
PLIST_FILES= bin/${PORTNAME}
GH_TUPLE= \
BurntSushi:toml:v0.3.1:burntsushi_toml/vendor/github.com/BurntSushi/toml \
agext:levenshtein:v1.2.1:agext_levenshtein/vendor/github.com/agext/levenshtein \
apparentlymart:go-textseg:v12.0.0:apparentlymart_go_textseg_v12/vendor/github.com/apparentlymart/go-textseg/v12 \
davecgh:go-spew:v1.1.1:davecgh_go_spew/vendor/github.com/davecgh/go-spew \
go-test:deep:v1.0.7:go_test_deep/vendor/github.com/go-test/deep \
go-yaml:yaml:2ff61e1afc86:go_yaml_yaml/vendor/gopkg.in/yaml.v3 \
golang:text:v0.3.2:golang_text/vendor/golang.org/x/text \
google:go-cmp:v0.3.1:google_go_cmp/vendor/github.com/google/go-cmp \
hashicorp:hcl:v1.0.0:hashicorp_hcl/vendor/github.com/hashicorp/hcl \
hashicorp:hcl:v2.6.0:hashicorp_hcl_v2/vendor/github.com/hashicorp/hcl/v2 \
iancoleman:orderedmap:ac98e3ecb4b0:iancoleman_orderedmap/vendor/github.com/iancoleman/orderedmap \
imdario:mergo:v0.3.11:imdario_mergo/vendor/github.com/imdario/mergo \
inconshreveable:mousetrap:v1.0.0:inconshreveable_mousetrap/vendor/github.com/inconshreveable/mousetrap \
mitchellh:go-wordwrap:ad45545899c7:mitchellh_go_wordwrap/vendor/github.com/mitchellh/go-wordwrap \
mvdan:xurls:v2.2.0:mvdan_xurls/vendor/mvdan.cc/xurls/v2 \
pmezard:go-difflib:v1.0.0:pmezard_go_difflib/vendor/github.com/pmezard/go-difflib \
spf13:cobra:v1.0.0:spf13_cobra/vendor/github.com/spf13/cobra \
spf13:pflag:v1.0.5:spf13_pflag/vendor/github.com/spf13/pflag \
stretchr:testify:v1.6.1:stretchr_testify/vendor/github.com/stretchr/testify \
zclconf:go-cty:v1.6.1:zclconf_go_cty/vendor/github.com/zclconf/go-cty
.include <bsd.port.mk>

View File

@ -0,0 +1,43 @@
TIMESTAMP = 1601431747
SHA256 (terraform-docs-terraform-docs-v0.10.1_GH0.tar.gz) = f3cc429d8edd129c73ca18feafd17bf1aacb0397b3653b7f65aa3978c4d6c337
SIZE (terraform-docs-terraform-docs-v0.10.1_GH0.tar.gz) = 164235
SHA256 (BurntSushi-toml-v0.3.1_GH0.tar.gz) = 6593da894578ba510a470735ffbdc88ce88033094dc5a8f4d3957ab87e18803f
SIZE (BurntSushi-toml-v0.3.1_GH0.tar.gz) = 42077
SHA256 (agext-levenshtein-v1.2.1_GH0.tar.gz) = c6e4bc2db1f0d9bc57fd3f1887567d527f6df1bcfbb079d1d1c4eab17f320b50
SIZE (agext-levenshtein-v1.2.1_GH0.tar.gz) = 12728
SHA256 (apparentlymart-go-textseg-v12.0.0_GH0.tar.gz) = f1d930b0902eccbb8264b368ffc77d73fc1f759aa1d4b7d97e1aed9635334f63
SIZE (apparentlymart-go-textseg-v12.0.0_GH0.tar.gz) = 125616
SHA256 (davecgh-go-spew-v1.1.1_GH0.tar.gz) = 7d82b9bb7291adbe7498fe946920ab3e7fc9e6cbfc3b2294693fad00bf0dd17e
SIZE (davecgh-go-spew-v1.1.1_GH0.tar.gz) = 42152
SHA256 (go-test-deep-v1.0.7_GH0.tar.gz) = c4c8e26ec8924e4608b669a4234f8b8880db8bb1f47ec6f22da0d4e8634fc849
SIZE (go-test-deep-v1.0.7_GH0.tar.gz) = 10199
SHA256 (go-yaml-yaml-2ff61e1afc86_GH0.tar.gz) = 3526f7d8921c73c4a8a950d37f2d1a4cb71655a6b85e7ebf0d96f779c27a301c
SIZE (go-yaml-yaml-2ff61e1afc86_GH0.tar.gz) = 87072
SHA256 (golang-text-v0.3.2_GH0.tar.gz) = 0b9309698f5708531c5377ab1e29b423a6d9e20c55a8d386c3b8283428212f22
SIZE (golang-text-v0.3.2_GH0.tar.gz) = 7168069
SHA256 (google-go-cmp-v0.3.1_GH0.tar.gz) = a95fa266e5c2283b813102f265c1bdf5b78100f9889b984aef828eb094efe6e3
SIZE (google-go-cmp-v0.3.1_GH0.tar.gz) = 76403
SHA256 (hashicorp-hcl-v1.0.0_GH0.tar.gz) = 50632428210503070fd2fde748c88b7414bf84a6a0eadebf9d8e596a033bead2
SIZE (hashicorp-hcl-v1.0.0_GH0.tar.gz) = 70658
SHA256 (hashicorp-hcl-v2.6.0_GH0.tar.gz) = 172ae4f4a6fd1f47c27e40f033dcb9e2bf51baca9824e0b37fe3cfbfff3c8ff4
SIZE (hashicorp-hcl-v2.6.0_GH0.tar.gz) = 392313
SHA256 (iancoleman-orderedmap-ac98e3ecb4b0_GH0.tar.gz) = 22c48471185f1458ad79ab0eb6ecf59dda6cc03bec72cde893bbec9df48b167f
SIZE (iancoleman-orderedmap-ac98e3ecb4b0_GH0.tar.gz) = 5897
SHA256 (imdario-mergo-v0.3.11_GH0.tar.gz) = 36544167ad735d458781b89ce3c3bfd56dd6ebdeadd5f3b4e1e0c6e0ab4f2191
SIZE (imdario-mergo-v0.3.11_GH0.tar.gz) = 22060
SHA256 (inconshreveable-mousetrap-v1.0.0_GH0.tar.gz) = 5edc7731c819c305623568e317aa253d342be3447def97f1fa9e10eb5ad819f6
SIZE (inconshreveable-mousetrap-v1.0.0_GH0.tar.gz) = 2290
SHA256 (mitchellh-go-wordwrap-ad45545899c7_GH0.tar.gz) = 917005b52e496fda7f702a88fb65a90cc5f2c8d5a569cf39aeaf1b536dd582d9
SIZE (mitchellh-go-wordwrap-ad45545899c7_GH0.tar.gz) = 2740
SHA256 (mvdan-xurls-v2.2.0_GH0.tar.gz) = 795d7febcf73503bca2ac9806f12ff6b33b47c13eef2d50b81b10e241d9bdb22
SIZE (mvdan-xurls-v2.2.0_GH0.tar.gz) = 18747
SHA256 (pmezard-go-difflib-v1.0.0_GH0.tar.gz) = 28f3dc1b5c0efd61203ab07233f774740d3bf08da4d8153fb5310db6cea0ebda
SIZE (pmezard-go-difflib-v1.0.0_GH0.tar.gz) = 11398
SHA256 (spf13-cobra-v1.0.0_GH0.tar.gz) = 58dbfe1b4dbc6751575e94d1e62d073098e0b41790bc1c7a7a95ec6b870ac697
SIZE (spf13-cobra-v1.0.0_GH0.tar.gz) = 128897
SHA256 (spf13-pflag-v1.0.5_GH0.tar.gz) = 9a2cae1f8e8ab0d2cc8ebe468e871af28d9ac0962cf0520999e3ba85f0c7b808
SIZE (spf13-pflag-v1.0.5_GH0.tar.gz) = 50796
SHA256 (stretchr-testify-v1.6.1_GH0.tar.gz) = 40fd7204ab72ca9d8759f1cc3604dd17f556a0f9177f6fc05dd0cad9f06e708f
SIZE (stretchr-testify-v1.6.1_GH0.tar.gz) = 84215
SHA256 (zclconf-go-cty-v1.6.1_GH0.tar.gz) = 02ba73f1a317f0cbe1886c9dbec851b64a654da1abf5726d2bc8b0a654c02409
SIZE (zclconf-go-cty-v1.6.1_GH0.tar.gz) = 180813

View File

@ -0,0 +1,20 @@
A utility to generate documentation from Terraform modules in various output
formats.
terraform-docs asciidoc ./my-terraform-module # asciidoc table
terraform-docs asciidoc table ./my-terraform-module # asciidoc table
terraform-docs asciidoc document ./my-terraform-module # asciidoc document
terraform-docs json ./my-terraform-module # json
terraform-docs markdown ./my-terraform-module # markdown table
terraform-docs markdown table ./my-terraform-module # markdown table
terraform-docs markdown document ./my-terraform-module # markdown document
terraform-docs pretty ./my-terraform-module # colorized pretty
terraform-docs tfvars hcl ./my-terraform-module # hcl format of
terraform.tfvars
terraform-docs tfvars json ./my-terraform-module # json format of
terraform.tfvars
terraform-docs toml ./my-terraform-module # toml
terraform-docs xml ./my-terraform-module # xml
terraform-docs yaml ./my-terraform-module # yaml
WWW: https://github.com/terraform-docs/terraform-docs