From af0b3d3e2608b40b624d333e14977750d1a937f5 Mon Sep 17 00:00:00 2001 From: Tanveer <116706588+Tanveer143s@users.noreply.github.com> Date: Wed, 24 Apr 2024 14:33:13 +0530 Subject: [PATCH] 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 Co-authored-by: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> --- .github/dependabot.yml | 6 +++--- .github/workflows/readme.yml | 13 +++++++------ .github/workflows/tf-checks.yml | 6 +++--- README.yaml | 19 ++++++++++++++++++- {_example => examples}/memcached/example.tf | 0 {_example => examples}/memcached/outputs.tf | 0 {_example => examples}/memcached/versions.tf | 0 .../redis-cluster/example.tf | 0 .../redis-cluster/outputs.tf | 0 .../redis-cluster/versions.tf | 0 {_example => examples}/redis/example.tf | 0 {_example => examples}/redis/outputs.tf | 0 {_example => examples}/redis/versions.tf | 0 variables.tf | 4 ++-- 14 files changed, 33 insertions(+), 15 deletions(-) rename {_example => examples}/memcached/example.tf (100%) rename {_example => examples}/memcached/outputs.tf (100%) rename {_example => examples}/memcached/versions.tf (100%) rename {_example => examples}/redis-cluster/example.tf (100%) rename {_example => examples}/redis-cluster/outputs.tf (100%) rename {_example => examples}/redis-cluster/versions.tf (100%) rename {_example => examples}/redis/example.tf (100%) rename {_example => examples}/redis/outputs.tf (100%) rename {_example => examples}/redis/versions.tf (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 2c22e93..1b532ef 100644 --- 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 index 132ced2..3d0c2f1 100644 --- 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/readme.yml@1.2.2 + README: + uses: clouddrove/github-shared-workflows/.github/workflows/readme.yml@1.2.4 secrets: - TOKEN: ${{ secrets.GITHUB }} - SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }} \ No newline at end of file + TOKEN : ${{ secrets.GITHUB }} + SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }} diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml index c1ab1a0..7ae8ce1 100644 --- 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/tf-checks.yml@1.0.9 with: - working_directory: './_example/memcached/' + working_directory: './examples/memcached/' redis: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/redis/' + working_directory: './examples/redis/' redis-cluster: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/redis-cluster/' + working_directory: './examples/redis-cluster/' diff --git a/README.yaml b/README.yaml index 8c4a37e..f07e36e 100644 --- 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 b/examples/memcached/example.tf similarity index 100% rename from _example/memcached/example.tf rename to examples/memcached/example.tf diff --git a/_example/memcached/outputs.tf b/examples/memcached/outputs.tf similarity index 100% rename from _example/memcached/outputs.tf rename to examples/memcached/outputs.tf diff --git a/_example/memcached/versions.tf b/examples/memcached/versions.tf similarity index 100% rename from _example/memcached/versions.tf rename to examples/memcached/versions.tf diff --git a/_example/redis-cluster/example.tf b/examples/redis-cluster/example.tf similarity index 100% rename from _example/redis-cluster/example.tf rename to examples/redis-cluster/example.tf diff --git a/_example/redis-cluster/outputs.tf b/examples/redis-cluster/outputs.tf similarity index 100% rename from _example/redis-cluster/outputs.tf rename to examples/redis-cluster/outputs.tf diff --git a/_example/redis-cluster/versions.tf b/examples/redis-cluster/versions.tf similarity index 100% rename from _example/redis-cluster/versions.tf rename to examples/redis-cluster/versions.tf diff --git a/_example/redis/example.tf b/examples/redis/example.tf similarity index 100% rename from _example/redis/example.tf rename to examples/redis/example.tf diff --git a/_example/redis/outputs.tf b/examples/redis/outputs.tf similarity index 100% rename from _example/redis/outputs.tf rename to examples/redis/outputs.tf diff --git a/_example/redis/versions.tf b/examples/redis/versions.tf similarity index 100% rename from _example/redis/versions.tf rename to examples/redis/versions.tf diff --git a/variables.tf b/variables.tf index bfa0ba4..28933fc 100644 --- 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." }