Skip to content

Commit 50d296a

Browse files
author
Dick Childress
committed
Upgrade terraform-docs to v0.17.0
Signed-off-by: Dick Childress <[email protected]>
1 parent b9ea051 commit 50d296a

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

.github/templates/README.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ branch.
1313

1414
## Version
1515

16-
`{{ $version }}` (uses [terraform-docs] v0.16.0, which is supported and tested on Terraform
16+
`{{ $version }}` (uses [terraform-docs] v0.17.0, which is supported and tested on Terraform
1717
version 0.11+ and 0.12+ but may work for others.)
1818

1919
{{- if eq $version "main" }}

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
FROM quay.io/terraform-docs/terraform-docs:0.16.0
15+
FROM quay.io/terraform-docs/terraform-docs:0.17.0
1616

1717
# this is explicitly needed because yq v4.x only exists in this repo.
1818
RUN echo "http://dl-4.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ branch.
88

99
## Version
1010

11-
`v1.0.0` (uses [terraform-docs] v0.16.0, which is supported and tested on Terraform
11+
`v1.0.0` (uses [terraform-docs] v0.17.0, which is supported and tested on Terraform
1212
version 0.11+ and 0.12+ but may work for others.)
1313

1414
### Upgrade v0 to v1
@@ -75,10 +75,10 @@ jobs:
7575
| indention | Indention level of Markdown sections [1, 2, 3, 4, 5] | `2` | false |
7676
| output-file | File in module directory where the docs should be placed | `README.md` | false |
7777
| output-format | terraform-docs format to generate content (see [all formats](https://github.com/terraform-docs/terraform-docs/blob/master/docs/FORMATS\_GUIDE.md)) (ignored if `config-file` is set) | `markdown table` | false |
78-
| output-method | Method should be one of `replace`, `inject`, or `print` | `inject` | false |
78+
| output-method | Method should be one of `replace`, `inject`, or `print`. Set as an empty string if `output.mode` and `output.file` are defined in config-file | `inject` | false |
7979
| recursive | If true it will update submodules recursively | `false` | false |
8080
| recursive-path | Submodules path to recursively update | `modules` | false |
81-
| template | When provided will be used as the template if/when the `output-file` does not exist | `<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->` | false |
81+
| template | When provided will be used as the template if/when the `output-file` does not exist. Set as an empty string if `output.template` is defined in config-file | `<!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->` | false |
8282
| working-dir | Comma separated list of directories to generate docs for (ignored if `atlantis-file` or `find-dir` is set) | `.` | false |
8383

8484
#### Output Method (output-method)

0 commit comments

Comments
 (0)