From 3d67b8b5744d6f6e217afeffc1143ab447e7e6d1 Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Wed, 10 Feb 2021 17:55:42 -0500 Subject: [PATCH 1/2] Update terraform-docs to v0.11.0 Signed-off-by: Khosrow Moossavi --- .github/templates/README.tpl | 2 +- .github/workflows/build.yml | 1 + Dockerfile | 2 +- README.md | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/templates/README.tpl b/.github/templates/README.tpl index 0517853..21ecc48 100644 --- a/.github/templates/README.tpl +++ b/.github/templates/README.tpl @@ -11,7 +11,7 @@ branch. ## Version -`{{ $version }}` (uses [terraform-docs] v0.10.1, which is supported and tested on Terraform +`{{ $version }}` (uses [terraform-docs] v0.11.0, which is supported and tested on Terraform version 0.11+ and 0.12+ but may work for others.) {{- if eq $version "main" }} diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8489525..cc119b0 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -70,6 +70,7 @@ jobs: args: --sort-by-required indention: 3 git-push: true + git-push-sign-off: true git-commit-message: "terraform-docs: automated action" - name: Should generate README.md for tf12_config diff --git a/Dockerfile b/Dockerfile index 02f342c..0d1c938 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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.10.1 +FROM quay.io/terraform-docs/terraform-docs:0.11.0 # this can be removed when base image # was upgraded to alpine:3.13 which has diff --git a/README.md b/README.md index 855fd49..0a66c72 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ branch. ## Version -`v0.4.0` (uses [terraform-docs] v0.10.1, which is supported and tested on Terraform +`v0.4.0` (uses [terraform-docs] v0.11.0, which is supported and tested on Terraform version 0.11+ and 0.12+ but may work for others.) ## Usage From 4ef7765675e843f608435100a2f3bdec37089c5c Mon Sep 17 00:00:00 2001 From: khos2ow Date: Wed, 10 Feb 2021 23:07:19 +0000 Subject: [PATCH 2/2] terraform-docs: automated action Signed-off-by: khos2ow --- examples/tf11_basic/USAGE.md | 11 +++++++++++ examples/tf11_extra_args/USAGE.md | 11 +++++++++++ examples/tf12_basic/README.md | 11 +++++++++++ examples/tf12_find/USAGE.md | 11 +++++++++++ .../tf12_find/modules/tf12_find_submodules/USAGE.md | 8 ++++++++ examples/tf12_inject/README.md | 11 +++++++++++ 6 files changed, 63 insertions(+) diff --git a/examples/tf11_basic/USAGE.md b/examples/tf11_basic/USAGE.md index 4a383fd..0f2c96e 100644 --- a/examples/tf11_basic/USAGE.md +++ b/examples/tf11_basic/USAGE.md @@ -22,6 +22,17 @@ Should inject the table under usage | aws | < 2.2.0 | | consul | >= 1.0.0 | +### Modules + +No Modules. + +### Resources + +| Name | +|------| +| [aws_acm_certificate](https://registry.terraform.io/providers/hashicorp/aws/2.2.0/docs/data-sources/acm_certificate) | +| [consul_key](https://registry.terraform.io/providers/hashicorp/consul/1.0.0/docs/data-sources/key) | + ### Inputs | Name | Description | Type | Default | Required | diff --git a/examples/tf11_extra_args/USAGE.md b/examples/tf11_extra_args/USAGE.md index 6e8d78d..85af499 100644 --- a/examples/tf11_extra_args/USAGE.md +++ b/examples/tf11_extra_args/USAGE.md @@ -6,6 +6,17 @@ The following providers are used by this module: - consul (>= 1.0.0) +### Modules + +No Modules. + +### Resources + +The following resources are used by this module: + +- [aws_acm_certificate](https://registry.terraform.io/providers/hashicorp/aws/2.2.0/docs/data-sources/acm_certificate) +- [consul_key](https://registry.terraform.io/providers/hashicorp/consul/1.0.0/docs/data-sources/key) + ### Inputs The following input variables are supported: diff --git a/examples/tf12_basic/README.md b/examples/tf12_basic/README.md index f06b01c..cd22d14 100644 --- a/examples/tf12_basic/README.md +++ b/examples/tf12_basic/README.md @@ -32,6 +32,17 @@ | aws | ~> 2.20.0 | | consul | >= 2.4.0 | +### Modules + +No Modules. + +### Resources + +| Name | +|------| +| [aws_acm_certificate](https://registry.terraform.io/providers/hashicorp/aws/2.20.0/docs/data-sources/acm_certificate) | +| [consul_key](https://registry.terraform.io/providers/hashicorp/consul/2.4.0/docs/data-sources/key) | + ### Inputs | Name | Description | Type | Default | Required | diff --git a/examples/tf12_find/USAGE.md b/examples/tf12_find/USAGE.md index 3b8818c..d060922 100644 --- a/examples/tf12_find/USAGE.md +++ b/examples/tf12_find/USAGE.md @@ -15,6 +15,17 @@ | aws | ~> 2.20.0 | | consul | >= 2.4.0 | +## Modules + +No Modules. + +## Resources + +| Name | +|------| +| [aws_acm_certificate](https://registry.terraform.io/providers/hashicorp/aws/2.20.0/docs/data-sources/acm_certificate) | +| [consul_key](https://registry.terraform.io/providers/hashicorp/consul/2.4.0/docs/data-sources/key) | + ## Inputs | Name | Description | Type | Default | Required | diff --git a/examples/tf12_find/modules/tf12_find_submodules/USAGE.md b/examples/tf12_find/modules/tf12_find_submodules/USAGE.md index 54d9252..04fa4c7 100644 --- a/examples/tf12_find/modules/tf12_find_submodules/USAGE.md +++ b/examples/tf12_find/modules/tf12_find_submodules/USAGE.md @@ -9,6 +9,14 @@ No requirements. No provider. +## Modules + +No Modules. + +## Resources + +No resources. + ## Inputs | Name | Description | Type | Default | Required | diff --git a/examples/tf12_inject/README.md b/examples/tf12_inject/README.md index 1609a7d..e881f5f 100644 --- a/examples/tf12_inject/README.md +++ b/examples/tf12_inject/README.md @@ -36,6 +36,17 @@ | aws | ~> 2.20.0 | | consul | >= 2.4.0 | +### Modules + +No Modules. + +### Resources + +| Name | +|------| +| [aws_acm_certificate](https://registry.terraform.io/providers/hashicorp/aws/2.20.0/docs/data-sources/acm_certificate) | +| [consul_key](https://registry.terraform.io/providers/hashicorp/consul/2.4.0/docs/data-sources/key) | + ### Inputs | Name | Description | Type | Default | Required |