Add tfmermaid

.github/workflows/terraform-ci.yaml

@@ -33,10 +33,10 @@ jobs:
 
   format:
     runs-on: ubuntu-22.04
-    name: Formate Terraform
+    name: Format Terraform
     permissions:
-        contents: write
-        pull-requests: write
+      contents: write
+      pull-requests: write
     steps:
     -
       name: Checkout
@@ -55,6 +55,32 @@ jobs:
         # Delete PR branch if diff is resolved anyhow
         delete-branch: true
         labels: |
-            bot
-            kind/cleanup
+          bot
+          kind/cleanup
 
+  tfmermaid:
+    runs-on: ubuntu-22.04
+    name: Update Terraform Diagram
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+    -
+      name: Checkout
+      uses: actions/checkout@v3
+    - uses: asannou/tfmermaid-action@v1
+      with:
+        file: README.md
+    -
+      name: Create Pull Request
+      uses: peter-evans/create-pull-request@v5
+      with:
+        commit-message: "📊 Generate Terraform diagrams using `tfmermaid`"
+        title: "📊 Generate Terraform Diagrams"
+        body: Update Terraform diagrams in README using `tfmermaid-action`
+        branch: refactor/tfmermaid
+        # Delete PR branch if diff is resolved anyhow
+        delete-branch: true
+        labels: |
+          bot
+          kind/cleanup

README.md

@@ -5,6 +5,11 @@
 ## Overview
 This Terraform configuration automates the setup of Azure CDN resources, streamlining the deployment and management of CDN infrastructure.
 
+### Terraform Architecture
+```mermaid
+%%tfmermaid
+```
+
 ## Features
 - **Resource Group Management**: Creates and manages Azure resource groups.
 - **DNS Zone Configuration**: Handles the setup and configuration of Azure DNS zones.
@@ -26,4 +31,4 @@ For usage examples, refer to the [`example`](./example) directory.
 ## Workflows
 | Name | Description |
 |---|---|
-| [terraform-ci.yaml](.github/workflows/terraform-ci.yaml) | A workflow for linting and auto-formatting Terraform code. Triggered by pushes to  `main` and `dev` branches or on pull requests, it consists of two jobs: `tflint` for lint checks and  `format` for code formatting and automated pull requests. |
+| [terraform-ci.yaml](.github/workflows/terraform-ci.yaml) | A workflow for linting and auto-formatting Terraform code. Triggered by pushes to  `main` and `dev` branches or on pull requests, it consists of two jobs: `tflint` for lint checks, `format` for code formatting and submit a PR, and `tfmermaid` to update architecture graph and submit a PR. |