Merge pull request #71 from clouddrove/Feat/update-module

feat: updated example path and readme paramters

.github/dependabot.yml

@@ -17,7 +17,7 @@ updates:
       - "approvers"
 
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/basic" # Location of package manifests
+    directory: "examples/basic" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -27,7 +27,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/complete" # Location of package manifests
+    directory: "examples/complete" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -37,7 +37,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/spot_instance" # Location of package manifests
+    directory: "examples/spot_instance" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees

.github/workflows/automerge.yml

@@ -8,5 +8,5 @@ jobs:
     secrets:
       GITHUB: ${{ secrets.GITHUB }}
     with:
-      tfcheck: 'spot_instance / Check code format'
+      tfcheck: 'examples/spot_instance / Check code format'
 ...

.github/workflows/readme.yml

@@ -1,54 +1,15 @@
-name: 'Create README.md file'
+name: Readme Workflow
 on:
   push:
     branches:
       - master
-
+    paths-ignore:
+      - 'README.md'
+      - 'docs/**'
+  workflow_dispatch:
 jobs:
-  readme:
-    name: 'readme-create'
-    runs-on: ubuntu-latest
-    steps:
-      - name: 'Checkout'
-        uses: actions/checkout@master
-
-      - name: 'Set up Python 3.7'
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.x'
-
-      - name: 'create readme'
-        uses: 'clouddrove/github-actions@9.0.3'
-        with:
-          actions_subcommand: 'readme'
-          github_token: '${{ secrets.GITHUB }}'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-
-      - name: 'pre-commit check errors'
-        uses: pre-commit/action@v3.0.1
-        continue-on-error: true
-
-      - name: 'pre-commit fix erros'
-        uses: pre-commit/action@v3.0.1
-        continue-on-error: true
-
-      - name: 'push readme'
-        uses: 'clouddrove/github-actions@9.0.3'
-        continue-on-error: true
-        with:
-          actions_subcommand: 'push'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: 'Slack Notification'
-        uses: clouddrove/action-slack@v2
-        with:
-          status: ${{ job.status }}
-          fields: repo,author
-          author_name: 'CloudDrove'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }} # required
-        if: always()
+  README:
+    uses: clouddrove/github-shared-workflows/.github/workflows/readme.yml@1.2.4
+    secrets:
+      TOKEN : ${{ secrets.GITHUB }}
+      SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }}

.github/workflows/tf-checks.yml

@@ -9,14 +9,14 @@ jobs:
   basic_example:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.4
     with:
-      working_directory: './_example/basic/'
+      working_directory: './examples/basic/'
   complete_example:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.4
     with:
-      working_directory: './_example/complete/'
+      working_directory: './examples/complete/'
   spot_instance:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.4
     with:
-      working_directory: './_example/spot_instance/'
+      working_directory: './examples/spot_instance/'
 ...
 

README.yaml

@@ -23,19 +23,29 @@ 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 1.4.6
+  - name: Terraform
     url: https://learn.hashicorp.com/terraform/getting-started/install.html
+    version: ">= 1.6.6"
+
+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 an EC2 resource on AWS with ElasticC IP Addresses and Elastic Block Store.
 
-# extra content
-include:
-  - "terraform.md"
-
 # How to use this project
 # How to use this project
 usage: |-