centersl/terraform-docs
1
0
Fork 0
mirror of https://github.com/terraform-docs/terraform-docs.git synced 2026-03-27 04:48:33 +07:00
Code Issues Packages Projects Releases Wiki Activity
836 Commits 9 Branches 38 Tags
master
Commit Graph

95 Commits

Author SHA1 Message Date
Pascal Hofmann
5b0c7d9d34 docs: add OpenSSF Best Practices badge 
Signed-off-by: Pascal Hofmann <mail@pascalhofmann.de>
 2025-12-12 15:30:07 +01:00
terraform-docs-bot
0643382b16 Release version v0.21.0 2025-12-12 13:58:42 +00:00
terraform-docs-bot
cf462c5da3 Release version v0.20.0 2025-04-04 21:13:10 +00:00
terraform-docs-bot
d64cd3b443 Release version v0.19.0 2024-09-18 16:53:55 +00:00
terraform-docs-bot
228c7a7284 Release version v0.18.0 2024-05-30 23:09:16 +00:00
Blake Gong
59eb90fc86 Make main module doc optional when in recursive generation 
Signed-off-by: Blake Gong <blakegong@gmail.com>
 2024-05-30 18:22:37 -04:00
Khosrow Moossavi
795d369fdc Release version v0.17.0 2023-12-19 13:31:44 -05:00
Khosrow Moossavi
6f6d2fa1fb Merge pull request #619 from FlorentPoinsaut/patch-1 
Move terraform-docs bin in a folder already in the Linux PATH
 2023-12-18 13:24:31 -05:00
Khosrow Moossavi
bb12a12d38 Remove Scalr sponsorship 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2023-03-01 17:40:19 -05:00
Khosrow Moossavi
ac2f98717b Update actions/checkout to v3 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2022-07-26 17:34:17 -04:00
Florent Poinsaut
230113fdd1 Move terraform-docs bin in a folder already in the Linux PATH 
Signed-off-by: Florent Poinsaut <florent@poinsaut.fr>
 2022-07-07 16:18:20 +02:00
Khosrow Moossavi
1f686b1bb3 Release version v0.16.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-10-05 19:16:17 -04:00
Khosrow Moossavi
4a9ffe7c33 Move plugin-sdk to in-tree in core repository 
Moving terraform-docs/plugin-sdk standalone module to in-tree, because
maintaining both of them, specifically if anything needs to be added to
Config, or terraform will required dual effort on both repository. As
such now everything is consolidated under one repository. Example usage
for plugin developer after this move is as follow:

```go
package main

import (
	_ "embed" //nolint

	"github.com/terraform-docs/terraform-docs/plugin"
	"github.com/terraform-docs/terraform-docs/print"
	"github.com/terraform-docs/terraform-docs/template"
	"github.com/terraform-docs/terraform-docs/terraform"
)

func main() {
	plugin.Serve(&plugin.ServeOpts{
		Name:    "template",
		Version: "0.1.0",
		Printer: printer,
	})
}

//go:embed sections.tmpl
var tplCustom []byte

// Print the custom format template. You have all the flexibility to generate
// the output however you choose to.
func printer(config *print.Config, module *terraform.Module) (string, error) {
	tpl := template.New(config,
		&template.Item{Name: "custom", Text: string(tplCustom)},
	)

	rendered, err := tpl.Render("custom", module)
	if err != nil {
		return "", err
	}

	return rendered, nil
}
```

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-10-05 18:54:49 -04:00
Khosrow Moossavi
465dd14cff Make terraform.Module available in content 
Add one extra special variable the `content`:

- `{{ .Module }}`

As opposed to the other variables, which are generated sections based on
a selected formatter, the `{{ .Module }}` variable is just a `struct`
representing a Terraform module.

It can be used to build highly complex and highly customized content:

```yaml
content: |-
  ## Resources

  {{ range .Module.Resources }}
  - {{ .GetMode }}.{{ .Spec }} ({{ .Position.Filename }}#{{ .Position.Line }})
  {{- end }}
```

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-10-04 20:01:44 -04:00
Khosrow Moossavi
54dc0f5a7c Add recursive config to .terraform-docs.yml file 
Up to now there was only one way to enable recursive execution and that
was with `--recursive` CLI flag. This enables the same behavior but
within config file (i.e. `.terraform-docs.yml`)

Example:

```yaml
recursive:
  enabled: false
  path: modules
```

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-30 15:53:22 -04:00
Khosrow Moossavi
bb109711a1 Deprecate Settings and Options in favor of Config 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-28 15:47:27 -04:00
Khosrow Moossavi
d2fe2b1b29 Move print package from internal to public 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-28 15:04:07 -04:00
Khosrow Moossavi
4f698fb177 Merge pull request #565 from poojitha-bikki/issue-552-dev 
optionally process comments from tf files as description
 2021-09-27 11:55:46 -04:00
Poojitha Bikki
045707beee feat: Add new flag 'read-comments' to optionally process comments as description 
fixes issue #552

- process description from comments

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- fix module tests

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- optionally read comments for output vars description

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- set default to true

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- run make docs

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- change option name

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add option in doc generator; make docs

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add config 'ReadComments'

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- Fix alphabetic order for 'ReadComments' setting

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add read-comments in docs

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- add test for readcomments option

Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>

- update 'read-comments' flag description

Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>
Signed-off-by: Poojitha Bikki <50849668+poojitha-bikki@users.noreply.github.com>
 2021-09-24 18:04:39 -05:00
Bryan Dady
519f25ee01 docs: fix typo in README and update configuration guide 
* docs: typo in README

Adjust typo, and suggest possible readability improvement, in README.

* Fix typo in Examples

replace 2 instances of providrs with providers

Signed-off-by: Bryan Dady <bryan@subsplash.com>

* docs: 📝 Update README and user-guide/configuration.md

Incorporate suggestions from PR https://github.com/terraform-docs/terraform-docs/pull/564

Signed-off-by: Bryan Dady <bryan@subsplash.com>

* docs: 📝 Update guide/configuration.md

Incorporate suggestions from PR https://github.com/terraform-docs/terraform-docs/pull/564

Signed-off-by: Bryan Dady <bryan@dady.us>
Signed-off-by: Bryan Dady <bryan@subsplash.com>
 2021-09-23 15:58:18 -04:00
Khosrow Moossavi
3d2b8788d6 Overhaul README and docs improvements 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-09-16 13:49:38 -04:00
Khosrow Moossavi
f3b6eab8a8 Release version v0.15.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-08-10 18:55:29 -04:00
JB Beck
8a288b53d4 Add Scalr sponsorship 
Signed-off-by: JB Beck <jb@scalr.com>
 2021-07-14 12:42:10 +02:00
Khosrow Moossavi
52f0ea072b Release version v0.14.1 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-06-01 16:51:54 -04:00
Khosrow Moossavi
69823736d5 Release version v0.14.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-05-31 13:37:43 -04:00
Khosrow Moossavi
43546028ad Release version v0.13.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-04-30 16:24:04 -04:00
Khosrow Moossavi
2784920341 Update doc to indicate minimum go1.16 is needed 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-04-22 13:24:55 -04:00
Khosrow Moossavi
4714dd3ef9 Release version v0.12.1 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-29 13:06:13 -04:00
Khosrow Moossavi
9c738b97c1 Release version v0.12.0 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-22 14:45:26 -04:00
Khosrow Moossavi
8faaf9f863 Remove authors file and corresponding scripts 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-16 13:49:06 -04:00
Khosrow Moossavi
9d9edfa38a Fix broken links 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-03-04 20:15:11 -05:00
Khosrow Moossavi
85473029b6 Update to go1.16 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-23 17:52:02 -05:00
Khosrow Moossavi
724458938b Fix typo 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-23 17:50:33 -05:00
Khosrow Moossavi
304bce9bb0 Refactor docs to be published on website 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-23 17:28:12 -05:00
Khosrow Moossavi
bd351fc70b Release version v0.11.2 2021-02-22 18:51:38 -05:00
Khosrow Moossavi
869f2b422d Release version v0.11.1 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-18 13:27:18 -05:00
Khosrow Moossavi
078ac5d482 Release version v0.11.0 2021-02-10 17:17:53 -05:00
Khosrow Moossavi
24e7cbab7d Update download instruction to use tar.gz 
We recently started using GoReleaser for release workflow and to be able
to support all the use-cases (brew, scopp, etc) the preferred way of
assets distribution is gonna be a packaged format (tar.z and zip).

For the time being the standalone binary will also be included in GitHub
release assets, but will be deprecated in the upcoming releases.

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-10 17:06:52 -05:00
Khosrow Moossavi
1919752f05 Update CI badges 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-07 15:59:02 -05:00
Khosrow Moossavi
189b6f7a5f Update Slack URL 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-06 16:41:14 -05:00
Khosrow Moossavi
aecd044ee0 Use goreleaser for release workflow and tasks 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-04 12:58:24 -05:00
Khosrow Moossavi
aa7224d264 Add Slack workspace link 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-02-01 12:59:27 -05:00
Khosrow Moossavi
44b3361b22 Add license header to codebase files 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-01-28 12:29:11 -05:00
dependabot[bot]
aa89342f7f build: bump golang from 1.15.2-alpine to 1.15.6-alpine (#352) 
* build: bump golang from 1.15.2-alpine to 1.15.6-alpine

Bumps golang from 1.15.2-alpine to 1.15.6-alpine.

Signed-off-by: dependabot[bot] <support@github.com>

* update CI to use go1.15.6

Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Khosrow Moossavi <khos2ow@gmail.com>
 2021-01-04 15:10:29 -05:00
Will Milton
3d8097e2d5 docs: add missing v to tag (#329) 
* add missing `v` to tag

so that copy paste works

* further additions of `v` and update one old ref

* remove `v` from docker image tag
 2020-09-30 14:23:27 -04:00
terraform-docs-bot
3e48d8f6b7 Release version v0.10.1 2020-09-28 18:17:49 -04:00
Khosrow Moossavi
c94dbee77d Fix typo 2020-09-25 12:17:11 -04:00
Khosrow Moossavi
5d9ad40605 Release version v0.10.0 2020-09-21 14:58:19 -04:00
dependabot[bot]
4de4aa2ac1 build: bump golang from 1.14.6 to 1.15.1 (#320) 
Bumps golang from 1.14.6to 1.15.1.

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 2020-09-02 15:46:33 -04:00
Alexandre Chaussier
7329e47a7c Fix typo in README (#303) 2020-08-04 21:21:37 -04:00