From e6802ee1ae2e01290fffe53088f9486b2f98a341 Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Fri, 31 May 2024 10:15:22 -0400 Subject: [PATCH 1/2] chore: prepare release v1.2.0 Signed-off-by: Khosrow Moossavi --- README.md | 16 ++++++++-------- action.yml | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f119519..af34656 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ branch. ## Version -`v1.1.0` (uses [terraform-docs] v0.17.0, which is supported and tested on Terraform +`v1.2.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 @@ -42,7 +42,7 @@ jobs: ref: ${{ github.event.pull_request.head.ref }} - name: Render terraform docs inside the README.md and push changes back to PR branch - uses: terraform-docs/gh-actions@v1.1.0 + uses: terraform-docs/gh-actions@v1.2.0 with: working-dir: . output-file: README.md @@ -147,7 +147,7 @@ To enable you need to ensure a few things first: ```yaml - name: Generate TF Docs - uses: terraform-docs/gh-actions@v1.1.0 + uses: terraform-docs/gh-actions@v1.2.0 with: working-dir: . ``` @@ -156,7 +156,7 @@ To enable you need to ensure a few things first: ```yaml - name: Generate TF Docs - uses: terraform-docs/gh-actions@v1.1.0 + uses: terraform-docs/gh-actions@v1.2.0 with: working-dir: .,example1,example3/modules/test ``` @@ -165,7 +165,7 @@ To enable you need to ensure a few things first: ```yaml - name: Generate TF docs - uses: terraform-docs/gh-actions@v1.1.0 + uses: terraform-docs/gh-actions@v1.2.0 with: atlantis-file: atlantis.yaml ``` @@ -174,7 +174,7 @@ To enable you need to ensure a few things first: ```yaml - name: Generate TF docs - uses: terraform-docs/gh-actions@v1.1.0 + uses: terraform-docs/gh-actions@v1.2.0 with: find-dir: examples/ ``` @@ -183,13 +183,13 @@ To enable you need to ensure a few things first: ```yaml - name: Generate TF docs - uses: terraform-docs/gh-actions@v1.1.0 + uses: terraform-docs/gh-actions@v1.2.0 with: working-dir: examples/ recursive: true recursive-path: modules ``` -Complete examples can be found [here](https://github.com/terraform-docs/gh-actions/tree/v1.1.0/examples). +Complete examples can be found [here](https://github.com/terraform-docs/gh-actions/tree/v1.2.0/examples). [terraform-docs]: https://github.com/terraform-docs/terraform-docs diff --git a/action.yml b/action.yml index c24e133..4944994 100644 --- a/action.yml +++ b/action.yml @@ -85,7 +85,7 @@ outputs: runs: using: docker - image: "docker://quay.io/terraform-docs/gh-actions:edge" + image: "docker://quay.io/terraform-docs/gh-actions:1.2.0" env: INPUT_WORKING_DIR: ${{ inputs.working-dir }} INPUT_ATLANTIS_FILE: ${{ inputs.atlantis-file }} From 4a2bc35cedbfafe06d56d97649155c3a5c779f2f Mon Sep 17 00:00:00 2001 From: Khosrow Moossavi Date: Fri, 31 May 2024 10:18:37 -0400 Subject: [PATCH 2/2] chore: bump terraform-docs to v0.18.0 Signed-off-by: Khosrow Moossavi --- .github/templates/README.tpl | 2 +- Dockerfile | 2 +- README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/templates/README.tpl b/.github/templates/README.tpl index 43a0246..bec24b3 100644 --- a/.github/templates/README.tpl +++ b/.github/templates/README.tpl @@ -13,7 +13,7 @@ branch. ## Version -`{{ $version }}` (uses [terraform-docs] v0.17.0, which is supported and tested on Terraform +`{{ $version }}` (uses [terraform-docs] v0.18.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/Dockerfile b/Dockerfile index 734473f..23a7f3e 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:edge +FROM quay.io/terraform-docs/terraform-docs:0.18.0 RUN set -x \ && apk update \ diff --git a/README.md b/README.md index af34656..e10fa9e 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ branch. ## Version -`v1.2.0` (uses [terraform-docs] v0.17.0, which is supported and tested on Terraform +`v1.2.0` (uses [terraform-docs] v0.18.0, which is supported and tested on Terraform version 0.11+ and 0.12+ but may work for others.) ### Upgrade v0 to v1