Merge pull request #34 from terraform-docs/yq

Move to yq v4 syntax

Author: khos2ow

.github/workflows/ci.yml

@@ -15,6 +15,9 @@ jobs:
           ref: ${{github.event.pull_request.head.ref}}
           repository: ${{github.event.pull_request.head.repo.full_name}}
 
+      - name: Build Docker image
+        run: docker build --pull --tag quay.io/terraform-docs/gh-actions:edge .
+
       - name: Should generate USAGE.md for tf11_basic
         uses: ./
         with:

examples/tf12_atlantis/README.md

@@ -20,45 +20,39 @@
 ## Usage
 
 <!--- BEGIN_TF_DOCS --->
-### Requirements
-
-| Name | Version |
-|------|---------|
-| aws | ~> 2.20.0 |
-| consul | >= 2.4.0 |
-
-### Providers
-
-| Name | Version |
-|------|---------|
-| aws | ~> 2.20.0 |
-| consul | >= 2.4.0 |
-
-### Modules
-
-No Modules.
-
-### Resources
-
-| Name |
-|------|
-| [aws_acm_certificate](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) |
-| [consul_key](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key) |
-
-### 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 |
-| instance\_name | Instance name prefix | `string` | `"test-"` | no |
-| 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 |
-
-### Outputs
-
-| Name | Description |
-|------|-------------|
-| vpc\_id | The Id of the VPC |
+### Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | ~> 2.20.0 |
+| <a name="requirement_consul"></a> [consul](#requirement\_consul) | >= 2.4.0 |
+
+### Modules
+
+No modules.
+
+### Resources
+
+| Name | Type |
+|------|------|
+| [aws_acm_certificate.test-cert](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/acm_certificate) | data source |
+| [consul_key.test](https://registry.terraform.io/providers/hashicorp/consul/latest/docs/data-sources/key) | data source |
+
+### Inputs
+
+| Name | Description | Type | Default | Required |
+|------|-------------|------|---------|:--------:|
+| <a name="input_extra_environment"></a> [extra\_environment](#input\_extra\_environment) | List of additional environment variables | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
+| <a name="input_extra_tags"></a> [extra\_tags](#input\_extra\_tags) | Additional tags | `map(string)` | `{}` | no |
+| <a name="input_instance_count"></a> [instance\_count](#input\_instance\_count) | Number of instances to create | `number` | `1` | no |
+| <a name="input_instance_name"></a> [instance\_name](#input\_instance\_name) | Instance name prefix | `string` | `"test-"` | no |
+| <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids) | A list of subnet ids to use | `list(string)` | n/a | yes |
+| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The id of the vpc | `string` | n/a | yes |
+
+### Outputs
+
+| Name | Description |
+|------|-------------|
+| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | The Id of the VPC |
+
 <!--- END_TF_DOCS --->

src/docker-entrypoint.sh

@@ -177,7 +177,7 @@ if [ -f "${GITHUB_WORKSPACE}/${ATLANTIS_FILE}" ]; then
   while read -r line; do
     project_dir=${line//- /}
     update_doc "${project_dir}"
-  done < <(yq r "${GITHUB_WORKSPACE}/${ATLANTIS_FILE}" 'projects[*].dir') # NOTE(khos2ow): this is v3 specific syntax
+  done < <(yq e '.projects[].dir' "${GITHUB_WORKSPACE}/${ATLANTIS_FILE}")
 elif [ -n "${FIND_DIR}" ] && [ "${FIND_DIR}" != "disabled" ]; then
   # Find all tf
   while read -r project_dir; do