chore: prepare release v1.0.8 (#21)

* chore: prepare release v1.0.8 * feat: Bump docs to v0.9.1 * chore: terraform-docs build * chore: add --no-requirements to examples * chore: terraform-docs build
Dirrk · May 28, 2020 · 26b7043 · 26b7043
1 parent dcc465b
commit 26b7043
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 17 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -28,7 +28,7 @@ jobs:
         tf_docs_working_dir: examples/tf11_extra_args
         tf_docs_content_type: document
         tf_docs_indention: '3'
-        tf_docs_args: '--no-required'
+        tf_docs_args: '--no-sensitive --no-requirements --no-required'
         tf_docs_output_method: replace
 
     - name: Should inject into README.md

diff --git a/Dockerfile b/Dockerfile
@@ -1,4 +1,4 @@
-FROM derekrada/terraform-docs:v1.0.7
+FROM derekrada/terraform-docs:v1.0.8
 COPY ./src/common.sh /common.sh
 COPY ./src/docker-entrypoint.sh /docker-entrypoint.sh
 

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # terraform-docs
 A Github action for generating terraform module documentation using terraform-docs and gomplate. In addition to statically defined directory modules, this module can search specific sub folders or parse atlantis.yaml for module identification and doc generation.  This action has the ability to auto commit docs to an open PR or after a push to a specific branch.
 ## Version
-v1.0.7
+v1.0.8
 
-Using [terraform-docs](https://github.com/segmentio/terraform-docs) v0.8.2, which is supported and tested on terraform version 0.11+ & 0.12+ but may work for others.
+Using [terraform-docs](https://github.com/segmentio/terraform-docs) v0.9.1, which is supported and tested on terraform version 0.11+ & 0.12+ but may work for others.
 
 
 
@@ -22,7 +22,7 @@ jobs:
         ref: ${{ github.event.pull_request.head.ref }}
 
     - name: Render terraform docs inside the USAGE.md and push changes back to PR branch
-      uses: Dirrk/terraform-docs@v1.0.7
+      uses: Dirrk/terraform-docs@v1.0.8
       with:
         tf_docs_working_dir: .
         tf_docs_output_file: USAGE.md
@@ -118,7 +118,7 @@ jobs:
 ## Simple / Single folder
 ```
 - name: Generate TF Docs
-  uses: Dirrk/terraform-docs@v1.0.7
+  uses: Dirrk/terraform-docs@v1.0.8
   with:
     tf_docs_working_dir: .
     tf_docs_output_file: README.md
@@ -127,7 +127,7 @@ jobs:
 ## Multi folder
 ```
 - name: Generate TF Docs
-  uses: Dirrk/terraform-docs@v1.0.7
+  uses: Dirrk/terraform-docs@v1.0.8
   with:
     tf_docs_working_dir: .,example1,example3/modules/test
     tf_docs_output_file: README.md
@@ -136,17 +136,17 @@ jobs:
 ## Use atlantis.yaml v3 to find all dirs
 ```
 - name: Generate TF docs
-  uses: Dirrk/terraform-docs@v1.0.7
+  uses: Dirrk/terraform-docs@v1.0.8
   with:
     tf_docs_atlantis_file: atlantis.yaml
 ```
 
 ## Find all .tf file folders under a given directory
 ```yaml
 - name: Generate TF docs
-  uses: Dirrk/terraform-docs@v1.0.7
+  uses: Dirrk/terraform-docs@v1.0.8
   with:
     tf_docs_find_dir: examples/
 ```
 
-Complete examples can be found [here](https://github.com/Dirrk/terraform-docs/tree/v1.0.7/examples)
+Complete examples can be found [here](https://github.com/Dirrk/terraform-docs/tree/v1.0.8/examples)
diff --git a/examples/tf11_basic/USAGE.md b/examples/tf11_basic/USAGE.md
@@ -2,6 +2,13 @@
 
 # Usage
 <!--- BEGIN_TF_DOCS --->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| aws | < 2.2.0 |
+| consul | >= 1.0.0 |
+
 ## Providers
 
 | Name | Version |
@@ -12,7 +19,7 @@
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:-----:|
+|------|-------------|------|---------|:--------:|
 | extra\_environment | List of additional environment variables | `list` | `[]` | no |
 | extra\_tags | Additional tags | `map` | `{}` | no |
 | instance\_count | Number of instances to create | `string` | `"1"` | no |

diff --git a/examples/tf11_extra_args/README.md b/examples/tf11_extra_args/README.md
@@ -8,7 +8,7 @@
     tf_docs_working_dir: examples/tf11_extra_args
     tf_docs_content_type: document
     tf_docs_indention: '3'
-    tf_docs_args: '--with-aggregate-type-defaults --no-required'
+    tf_docs_args: '--no-sensitive --no-requirements --no-required'
     tf_docs_output_method: replace
 ```
 

diff --git a/examples/tf12_atlantis/README.md b/examples/tf12_atlantis/README.md
@@ -14,10 +14,17 @@
 
 # Usage
 <!--- BEGIN_TF_DOCS --->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| aws | ~> 2.20.0 |
+| consul | >= 2.4.0 |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:-----:|
+|------|-------------|------|---------|:--------:|
 | extra\_environment | List of additional environment variables | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
 | extra\_tags | Additional tags | `map(string)` | `{}` | no |
 | instance\_count | Number of instances to create | `number` | `1` | no |

diff --git a/examples/tf12_basic/README.md b/examples/tf12_basic/README.md
@@ -15,6 +15,13 @@
 # Usage
 
 <!--- BEGIN_TF_DOCS --->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| aws | ~> 2.20.0 |
+| consul | >= 2.4.0 |
+
 ## Providers
 
 | Name | Version |
@@ -25,7 +32,7 @@
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:-----:|
+|------|-------------|------|---------|:--------:|
 | extra\_environment | List of additional environment variables | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
 | extra\_tags | Additional tags | `map(string)` | `{}` | no |
 | instance\_count | Number of instances to create | `number` | `1` | no |

diff --git a/examples/tf12_find/USAGE.md b/examples/tf12_find/USAGE.md
@@ -1,5 +1,12 @@
 # Usage
 <!--- BEGIN_TF_DOCS --->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| aws | ~> 2.20.0 |
+| consul | >= 2.4.0 |
+
 ## Providers
 
 | Name | Version |
@@ -10,7 +17,7 @@
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:-----:|
+|------|-------------|------|---------|:--------:|
 | extra\_environment | List of additional environment variables | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
 | extra\_tags | Additional tags | `map(string)` | `{}` | no |
 | instance\_count | Number of instances to create | `number` | `1` | no |

diff --git a/examples/tf12_find/modules/tf12_find_submodules/USAGE.md b/examples/tf12_find/modules/tf12_find_submodules/USAGE.md
@@ -1,13 +1,17 @@
 # Usage
 <!--- BEGIN_TF_DOCS --->
+## Requirements
+
+No requirements.
+
 ## Providers
 
 No provider.
 
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:-----:|
+|------|-------------|------|---------|:--------:|
 | extra\_environment | List of additional environment variables | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
 | extra\_tags | Additional tags | `map(string)` | `{}` | no |
 | instance\_count | Number of instances to create | `number` | `1` | no |

diff --git a/examples/tf12_inject/README.md b/examples/tf12_inject/README.md
@@ -17,6 +17,13 @@
 
 # Usage
 <!--- BEGIN_TF_DOCS --->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| aws | ~> 2.20.0 |
+| consul | >= 2.4.0 |
+
 ## Providers
 
 | Name | Version |
@@ -27,7 +34,7 @@
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|------|---------|:-----:|
+|------|-------------|------|---------|:--------:|
 | subnet\_ids | A list of subnet ids to use | `list(string)` | n/a | yes |
 | vpc\_id | The id of the vpc | `string` | n/a | yes |
 | extra\_environment | List of additional environment variables | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |