Skip to content

Commit

Permalink
Upgrade terraform-docs to v0.17.0
Browse files Browse the repository at this point in the history
Signed-off-by: Dick Childress <[email protected]>
  • Loading branch information
Dick Childress committed Feb 19, 2024
1 parent b9ea051 commit 50d296a
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/templates/README.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ branch.

## Version

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

{{- if eq $version "main" }}
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.

FROM quay.io/terraform-docs/terraform-docs:0.16.0
FROM quay.io/terraform-docs/terraform-docs:0.17.0

# this is explicitly needed because yq v4.x only exists in this repo.
RUN echo "http://dl-4.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ branch.

## Version

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

### Upgrade v0 to v1
Expand Down Expand Up @@ -75,10 +75,10 @@ jobs:
| indention | Indention level of Markdown sections [1, 2, 3, 4, 5] | `2` | false |
| output-file | File in module directory where the docs should be placed | `README.md` | false |
| 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 |
| output-method | Method should be one of `replace`, `inject`, or `print` | `inject` | false |
| 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 |
| recursive | If true it will update submodules recursively | `false` | false |
| recursive-path | Submodules path to recursively update | `modules` | false |
| 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 |
| 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 |
| working-dir | Comma separated list of directories to generate docs for (ignored if `atlantis-file` or `find-dir` is set) | `.` | false |

#### Output Method (output-method)
Expand Down

0 comments on commit 50d296a

Please sign in to comment.