Merge pull request #16 from infraspecdev/test/workflow

ci: Update workflows

Author: nimisha-gj

.github/workflows/pre-commit.yaml .github/workflows/docs-checks.yaml.github/workflows/pre-commit.yaml renamed to .github/workflows/docs-checks.yaml

@@ -1,4 +1,4 @@
-name: Pre-Commit
+name: Terraform Docs & Checks
 
 on:
   push:
@@ -11,32 +11,35 @@ on:
       - master
 
 env:
-  TERRAFORM_DOCS_VERSION: v0.16.0
+  TERRAFORM_DOCS_VERSION: v0.18.0
   TFLINT_VERSION: v0.50.3
 
 jobs:
-  docs:
+  generateDocs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
           ref: ${{ github.event.pull_request.head.ref }}
 
-      - name: Render terraform docs and push changes back to PR
+      - name: Render and Push terraform docs for main and modules
         uses: terraform-docs/gh-actions@main
         with:
           working-dir: .
-          recursive: true
-          recursive-path: modules
-          output-file: README.md
-          output-method: replace
           git-push: true
-          template: <!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->\n{{- printf "\n" -}}
+          config-file: .terraform-docs.yaml
 
+      - name: Render and Push terraform docs for examples
+        uses: terraform-docs/gh-actions@main
+        with:
+          working-dir: .
+          git-push: true
+          config-file: .terraform-docs-example.yaml
 
   collectInputs:
     name: Collect workflow inputs
+    needs: generateDocs
     runs-on: ubuntu-latest
     outputs:
       directories: ${{ steps.dirs.outputs.directories }}

.github/workflows/documentation.yaml

@@ -4,9 +4,6 @@ on:
   push:
     branches:
       - main
-  pull_request:
-    branches:
-      - main
 
 defaults:
   run:

.github/workflows/release.yaml

@@ -26,3 +26,4 @@ repos:
       - id: check-merge-conflict
       - id: end-of-file-fixer
       - id: trailing-whitespace
+exclude: README.md

.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+  formatter: "markdown table"
+
+  header-from: ../../example.header.md
+  footer-from: ""
+
+  recursive:
+    enabled: true
+    path: examples
+    include-main: false
+
+  output:
+    file: "README.md"
+    mode: replace
+    template: |-
+      <!-- BEGIN_TF_DOCS -->
+      {{ .Content }}
+      <!-- END_TF_DOCS -->
+      {{- printf "\n" -}}
+
+  sort:
+    enabled: true
+    by: name
+
+  settings:
+    anchor: true
+    color: true
+    default: true
+    description: false
+    escape: true
+    hide-empty: false
+    html: true
+    indent: 2
+    lockfile: true
+    read-comments: true
+    required: true
+    sensitive: true
+    type: true

.terraform-docs-example.yaml

@@ -0,0 +1,11 @@
+    ## Usage
+
+  To run this example you need to execute:
+
+  ```bash
+  $ terraform init
+  $ terraform plan
+  $ terraform apply
+  ```
+
+  Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.

example.header.md

@@ -1,4 +1,16 @@
 <!-- BEGIN_TF_DOCS -->
+    ## Usage
+
+  To run this example you need to execute:
+
+  ```bash
+  $ terraform init
+  $ terraform plan
+  $ terraform apply
+  ```
+
+  Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.
+
 ## Requirements
 
 | Name | Version |
@@ -8,9 +20,7 @@
 
 ## Providers
 
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
+No providers.
 
 ## Modules
 

examples/assign-users-and-groups-to-account/README.md

@@ -17,6 +17,18 @@ Note that this example may create resources which may cost money. Run `terraform
 
 
 <!-- BEGIN_TF_DOCS -->
+    ## Usage
+
+  To run this example you need to execute:
+
+  ```bash
+  $ terraform init
+  $ terraform plan
+  $ terraform apply
+  ```
+
+  Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.
+
 ## Requirements
 
 | Name | Version |
@@ -25,9 +37,8 @@ Note that this example may create resources which may cost money. Run `terraform
 | <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.51.0 |
 
 ## Providers
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
+
+No providers.
 
 ## Modules
 

examples/create-member-account/README.md

@@ -16,6 +16,18 @@ Note that this example may create resources which may cost money. Run `terraform
 
 
 <!-- BEGIN_TF_DOCS -->
+    ## Usage
+
+  To run this example you need to execute:
+
+  ```bash
+  $ terraform init
+  $ terraform plan
+  $ terraform apply
+  ```
+
+  Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.
+
 ## Requirements
 
 | Name | Version |
@@ -25,9 +37,7 @@ Note that this example may create resources which may cost money. Run `terraform
 
 ## Providers
 
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
+No providers.
 
 ## Modules
 

examples/create-organization/README.md

@@ -16,6 +16,18 @@ Note that this example may create resources which may cost money. Run `terraform
 
 
 <!-- BEGIN_TF_DOCS -->
+    ## Usage
+
+  To run this example you need to execute:
+
+  ```bash
+  $ terraform init
+  $ terraform plan
+  $ terraform apply
+  ```
+
+  Note that this example may create resources which may cost money. Run `terraform destroy` when you don't need these resources.
+
 ## Requirements
 
 | Name | Version |
@@ -25,9 +37,7 @@ Note that this example may create resources which may cost money. Run `terraform
 
 ## Providers
 
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
+No providers.
 
 ## Modules