Merge pull request #63 from clouddrove/feat/update-module

feat: updated example path and readme paramters

.github/dependabot.yml

@@ -15,7 +15,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/anomaly_example" # Location of package manifests
+    directory: "examples/anomaly_example" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -25,7 +25,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/basic_example" # Location of package manifests
+    directory: "examples/basic_example" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -35,7 +35,7 @@ updates:
     reviewers:
       - "approvers"
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "_example/expression_example" # Location of package manifests
+    directory: "examples/expression_example" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees

.github/workflows/readme.yml

@@ -1,53 +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@v4
-        with:
-          python-version: '3.x'
-
-      - name: 'create readme'
-        uses: 'clouddrove/github-actions@v9.0.2'
-        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.0
-        continue-on-error: true
-
-      - name: 'pre-commit fix erros'
-        uses: pre-commit/action@v3.0.0
-        continue-on-error: true
-
-      - name: 'push readme'
-        uses: 'clouddrove/github-actions@v9.0.2'
-        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

@@ -8,12 +8,12 @@ jobs:
   tf-checks-anomaly-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.1
     with:
-      working_directory: './_example/anomaly_example/'
+      working_directory: './examples/anomaly_example/'
   tf-checks-basic-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.1
     with:
-      working_directory: './_example/basic_example/'
+      working_directory: './examples/basic_example/'
   tf-checks-expression-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.1
     with:
-      working_directory: './_example/expression_example/'
+      working_directory: './examples/expression_example/'

README.yaml

@@ -24,15 +24,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
+    url: https://learn.hashicorp.com/terraform/getting-started/install.html
+    version: ">= 1.6.6"
+
+providers:
+  - name: aws
+    url: https://aws.amazon.com/
+    version: ">= 5.29.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 creates Cloudwatch Alarm on AWS for monitoriing AWS services.
 
-# extra content
-include:
-  - "terraform.md"
-
 # How to use this project
 # yamllint disable rule:line-length
 usage: |-