feat: updated example path and readme parameters (#70)

* feat: updated example path and readme parameters * fmt- terraform format * feat- Updated Path for Ignore File --------- Co-authored-by: Vishwajit Nagulkar <[email protected]> Co-authored-by: Vishwajit Nagulkar <[email protected]>
clouddrove · Apr 24, 2024 · af0b3d3 · af0b3d3
1 parent c7422b5
commit af0b3d3
Show file tree

Hide file tree

Showing 14 changed files with 33 additions and 15 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -16,7 +16,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/memcached" # Location of package manifests
+    directory: "examples/memcached" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -26,7 +26,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/redis" # Location of package manifests
+    directory: "examples/redis" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -36,7 +36,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/redis-cluster" # Location of package manifests
+    directory: "examples/redis-cluster" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees

diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml
@@ -1,14 +1,15 @@
-name: 'Create README.md file'
+name: Readme Workflow
 on:
   push:
     branches:
       - master
     paths-ignore:
       - 'README.md'
-
+      - 'docs/**'
+  workflow_dispatch:
 jobs:
-  readme-create:
-    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].2
+  README:
+    uses: clouddrove/github-shared-workflows/.github/workflows/[email protected].4
     secrets:
-      TOKEN: ${{ secrets.GITHUB }}
-      SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }}
+      TOKEN : ${{ secrets.GITHUB }}
+      SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }}
diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml
@@ -8,12 +8,12 @@ jobs:
   memcached:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-      working_directory: './_example/memcached/'
+      working_directory: './examples/memcached/'
   redis:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-      working_directory: './_example/redis/'
+      working_directory: './examples/redis/'
   redis-cluster:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-      working_directory: './_example/redis-cluster/'
+      working_directory: './examples/redis-cluster/'
diff --git a/README.yaml b/README.yaml
@@ -24,7 +24,24 @@ badges:
   - name: "Licence"
     image: "https://img.shields.io/badge/License-APACHE-blue.svg"
     url: "LICENSE.md"
-
+  - name: "Changelog"
+    image: "https://img.shields.io/badge/Changelog-blue"
+    url: "CHANGELOG.md"
+
+prerequesties:
+  - name: Terraform
+    url: https://learn.hashicorp.com/terraform/getting-started/install.html
+    version: ">= 1.6.5"
+
+providers:
+  - name: aws
+    url: https://aws.amazon.com/
+    version: ">= 5.31.0"
+
+module_dependencies:
+  - name: Labels Module
+    url: https://github.com/clouddrove/terraform-aws-labels
+    description: Provides resource tagging.
 #  description of this project
 description: |-
   Terraform module to create Elasticache Cluster and replica for Redis and Memcache.

diff --git a/_example/memcached/example.tf → examples/memcached/example.tf b/_example/memcached/example.tf → examples/memcached/example.tf
diff --git a/_example/memcached/outputs.tf → examples/memcached/outputs.tf b/_example/memcached/outputs.tf → examples/memcached/outputs.tf
diff --git a/_example/memcached/versions.tf → examples/memcached/versions.tf b/_example/memcached/versions.tf → examples/memcached/versions.tf
diff --git a/_example/redis-cluster/example.tf → examples/redis-cluster/example.tf b/_example/redis-cluster/example.tf → examples/redis-cluster/example.tf
diff --git a/_example/redis-cluster/outputs.tf → examples/redis-cluster/outputs.tf b/_example/redis-cluster/outputs.tf → examples/redis-cluster/outputs.tf
diff --git a/_example/redis-cluster/versions.tf → examples/redis-cluster/versions.tf b/_example/redis-cluster/versions.tf → examples/redis-cluster/versions.tf
diff --git a/_example/redis/example.tf → examples/redis/example.tf b/_example/redis/example.tf → examples/redis/example.tf
diff --git a/_example/redis/outputs.tf → examples/redis/outputs.tf b/_example/redis/outputs.tf → examples/redis/outputs.tf
diff --git a/_example/redis/versions.tf → examples/redis/versions.tf b/_example/redis/versions.tf → examples/redis/versions.tf
diff --git a/variables.tf b/variables.tf
@@ -169,8 +169,8 @@ variable "key_usage" {
 }
 
 variable "network_type" {
-  type = string
-  default = "ipv4"
+  type        = string
+  default     = "ipv4"
   description = "value of the network type. Valid values are ipv4, ipv6 or dual_stack."
 }