@@ -39,7 +39,7 @@ Stable binaries are also available on the [releases] page. To install, download
39
39
binary for your platform from "Assets" and place this into your ` $PATH ` :
40
40
41
41
``` bash
42
- curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/download/v0.16 .0/terraform-docs-v0.16 .0-$( uname) -amd64.tar.gz
42
+ curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/download/v0.17 .0/terraform-docs-v0.17 .0-$( uname) -amd64.tar.gz
43
43
tar -xzf terraform-docs.tar.gz
44
44
chmod +x terraform-docs
45
45
mv terraform-docs /usr/local/bin/terraform-docs
@@ -51,12 +51,12 @@ The latest version can be installed using `go install` or `go get`:
51
51
52
52
``` bash
53
53
# go1.17+
54
- go install github.com/terraform-docs/terraform-docs@v0.16 .0
54
+ go install github.com/terraform-docs/terraform-docs@v0.17 .0
55
55
```
56
56
57
57
``` bash
58
58
# go1.16
59
- GO111MODULE=" on" go get github.com/terraform-docs/terraform-docs@v0.16 .0
59
+ GO111MODULE=" on" go get github.com/terraform-docs/terraform-docs@v0.17 .0
60
60
```
61
61
62
62
** NOTE:** please use the latest Go to do this, minimum ` go1.16 ` is required.
@@ -88,14 +88,14 @@ terraform-docs can be run as a container by mounting a directory with `.tf`
88
88
files in it and run the following command:
89
89
90
90
``` bash
91
- docker run --rm --volume " $( pwd) :/terraform-docs" -u $( id -u) quay.io/terraform-docs/terraform-docs:0.16 .0 markdown /terraform-docs
91
+ docker run --rm --volume " $( pwd) :/terraform-docs" -u $( id -u) quay.io/terraform-docs/terraform-docs:0.17 .0 markdown /terraform-docs
92
92
```
93
93
94
94
If ` output.file ` is not enabled for this module, generated output can be redirected
95
95
back to a file:
96
96
97
97
``` bash
98
- docker run --rm --volume " $( pwd) :/terraform-docs" -u $( id -u) quay.io/terraform-docs/terraform-docs:0.16 .0 markdown /terraform-docs > doc.md
98
+ docker run --rm --volume " $( pwd) :/terraform-docs" -u $( id -u) quay.io/terraform-docs/terraform-docs:0.17 .0 markdown /terraform-docs > doc.md
99
99
```
100
100
101
101
** NOTE:** Docker tag ` latest ` refers to _ latest_ stable released version and ` edge `
@@ -142,7 +142,7 @@ in the root of your Git repo with at least the following content:
142
142
` ` ` yaml
143
143
repos:
144
144
- repo: https://github.com/terraform-docs/terraform-docs
145
- rev: "v0.16 .0"
145
+ rev: "v0.17 .0"
146
146
hooks:
147
147
- id: terraform-docs-go
148
148
args: ["markdown", "table", "--output-file", "README.md", "./mymodule/path"]
0 commit comments