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

Release version v0.16.0

Browse Source 
Signed-off-by: Khosrow Moossavi <khos2ow@gmail.com>
This commit is contained in:
Khosrow Moossavi
2021-10-05 19:16:17 -04:00
parent b0bf022e57
commit 1f686b1bb3
3 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -43,7 +43,7 @@ Stable binaries are also available on the [releases] page. To install, download
binary for your platform from "Assets" and place this into your `$PATH`:
```bash
curl -Lo ./terraform-docs.tar.gz https://github.com/terraform-docs/terraform-docs/releases/download/v0.15.0/terraform-docs-v0.15.0-$(uname)-amd64.tar.gz
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
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
mv terraform-docs /usr/local/terraform-docs
@@ -55,12 +55,12 @@ The latest version can be installed using `go install` or `go get`:
```bash
# go1.17+
go install github.com/terraform-docs/terraform-docs@v0.15.0
go install github.com/terraform-docs/terraform-docs@v0.16.0
```
```bash
# go1.16
GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.15.0
GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.16.0
```
**NOTE:** please use the latest Go to do this, minimum `go1.16` is required.
@@ -92,14 +92,14 @@ terraform-docs can be run as a container by mounting a directory with `.tf`
files in it and run the following command:
```bash
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.15.0 markdown /terraform-docs
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.16.0 markdown /terraform-docs
```
If `output.file` is not enabled for this module, generated output can be redirected
back to a file:
```bash
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.15.0 markdown /terraform-docs > doc.md
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.16.0 markdown /terraform-docs > doc.md
```
**NOTE:** Docker tag `latest` refers to _latest_ stable released version and `edge`
@@ -146,7 +146,7 @@ in the root of your Git repo with at least the following content:
```yaml
repos:
- repo: https://github.com/terraform-docs/terraform-docs
rev: "v0.15.0"
rev: "v0.16.0"
hooks:
- id: terraform-docs-go
args: ["markdown", "table", "--output-file", "README.md", "./mymodule/path"]

10
docs/user-guide/installation.md
View File

@@ -51,14 +51,14 @@ terraform-docs can be run as a container by mounting a directory with `.tf`
files in it and run the following command:
```bash
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.15.0 markdown /terraform-docs
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.16.0 markdown /terraform-docs
```
If `output.file` is not enabled for this module, generated output can be redirected
back to a file:
```bash
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.15.0 markdown /terraform-docs > doc.md
docker run --rm --volume "$(pwd):/terraform-docs" -u $(id -u) quay.io/terraform-docs/terraform-docs:0.16.0 markdown /terraform-docs > doc.md
```
{{< alert type="primary" >}}
@@ -73,7 +73,7 @@ Stable binaries are available on the GitHub [Release] page. To install, download
the file for your platform from "Assets" and place it into your `$PATH`:
```bash
curl -sSLo ./terraform-docs.tar.gz https://terraform-docs.io/dl/v0.15.0/terraform-docs-v0.15.0-$(uname)-amd64.tar.gz
curl -sSLo ./terraform-docs.tar.gz https://terraform-docs.io/dl/v0.16.0/terraform-docs-v0.16.0-$(uname)-amd64.tar.gz
tar -xzf terraform-docs.tar.gz
chmod +x terraform-docs
mv terraform-docs /some-dir-in-your-PATH/terraform-docs
@@ -89,12 +89,12 @@ The latest version can be installed using `go install` or `go get`:
```bash
# go1.17+
go install github.com/terraform-docs/terraform-docs@v0.15.0
go install github.com/terraform-docs/terraform-docs@v0.16.0
```
```bash
# go1.16
GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.15.0
GO111MODULE="on" go get github.com/terraform-docs/terraform-docs@v0.16.0
```
{{< alert type="warning" >}}

2
internal/version/version.go
View File

@@ -18,7 +18,7 @@ import (
// current version
const (
coreVersion = "0.16.0"
prerelease = "alpha"
prerelease = ""
)
// Provisioned by ldflags