From c547d87c47525717f889ebdfe160a3461604d17b Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Tue, 10 Aug 2021 19:13:23 -0400 Subject: [PATCH] Upgrade terraform-docs to v0.15.0 Signed-off-by: Khosrow Moossavi --- .github/templates/README.tpl | 2 +- .github/workflows/ci.yml | 2 +- Dockerfile | 2 +- README.md | 2 +- examples/tf12_inject/README.md | 50 +++++++++++++++++----------------- 5 files changed, 29 insertions(+), 29 deletions(-) diff --git a/.github/templates/README.tpl b/.github/templates/README.tpl index 0d06037..d9e6710 100644 --- a/.github/templates/README.tpl +++ b/.github/templates/README.tpl @@ -12,7 +12,7 @@ branch. ## Version -`{{ $version }}` (uses [terraform-docs] v0.14.1, which is supported and tested on Terraform +`{{ $version }}` (uses [terraform-docs] v0.15.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/ci.yml b/.github/workflows/ci.yml index 0ed2b96..5996eb0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -86,7 +86,7 @@ jobs: with: working-dir: examples/tf12_inject output-file: README.md - args: --sort-by-required + args: --sort-by required indention: 3 git-push: true git-push-sign-off: true diff --git a/Dockerfile b/Dockerfile index cff8fc5..caae58d 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.14.1 +FROM quay.io/terraform-docs/terraform-docs:0.15.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 diff --git a/README.md b/README.md index a2df833..6a6f05f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ branch. ## Version -`v0.9.0` (uses [terraform-docs] v0.14.1, which is supported and tested on Terraform +`v0.9.0` (uses [terraform-docs] v0.15.0, which is supported and tested on Terraform version 0.11+ and 0.12+ but may work for others.) ## Usage diff --git a/examples/tf12_inject/README.md b/examples/tf12_inject/README.md index 8449d3a..c74c41c 100644 --- a/examples/tf12_inject/README.md +++ b/examples/tf12_inject/README.md @@ -1,27 +1,27 @@ -# Test Inject - -## Input - -```yaml -- name: Should generate README.md for tf12_inject and push up all changes - uses: ./ - with: - working-dir: examples/tf12_inject - output-file: README.md - args: --sort-by-required - indention: 3 - git-push: true - git-commit-message: "terraform-docs: automated action" -``` - -## Verify - -- Should inject below Usage -- Should push up changes on build with commit message 'terraform-docs: automated action' - -## Usage - - +# Test Inject + +## Input + +```yaml +- name: Should generate README.md for tf12_inject and push up all changes + uses: ./ + with: + working-dir: examples/tf12_inject + output-file: README.md + args: --sort-by required + indention: 3 + git-push: true + git-commit-message: "terraform-docs: automated action" +``` + +## Verify + +- Should inject below Usage +- Should push up changes on build with commit message 'terraform-docs: automated action' + +## Usage + + ### Requirements | Name | Version | @@ -64,4 +64,4 @@ No modules. |------|-------------| | [vpc\_id](#output\_vpc\_id) | The Id of the VPC | - +