feat: updated example path and readme paramters (#54)

* feat: updated example path and readme paramters * feat: updated example path and readme paramters * feat: updated example path and readme paramters * feat: updated example path and readme paramters * feat- added path for ignore file in GHA --------- Co-authored-by: Vishwajit Nagulkar <[email protected]>
clouddrove · Apr 25, 2024 · 3f21362 · 3f21362
1 parent 65d891d
commit 3f21362
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 62 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -28,7 +28,7 @@ updates:
     open-pull-requests-limit: 3
 
   - 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
@@ -41,7 +41,7 @@ updates:
     open-pull-requests-limit: 3
 
   - 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
@@ -54,7 +54,7 @@ updates:
     open-pull-requests-limit: 3
 
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "/_example/only_rules" # Location of package manifests
+    directory: "/examples/only_rules" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees
@@ -67,7 +67,7 @@ updates:
     open-pull-requests-limit: 3
 
   - package-ecosystem: "terraform" # See documentation for possible values
-    directory: "/_example/prefix_list" # Location of package manifests
+    directory: "/examples/prefix_list" # Location of package manifests
     schedule:
       interval: "weekly"
     # Add assignees

diff --git a/.github/workflows/readme.yml b/.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-create:
-    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/[email protected]'
-        with:
-          actions_subcommand: 'readme'
-          github_token: '${{ secrets.GITHUB }}'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-
-      - name: 'pre-commit check errors'
-        uses: pre-commit/[email protected]
-        continue-on-error: true
-
-      - name: 'pre-commit fix erros'
-        uses: pre-commit/[email protected]
-        continue-on-error: true
-
-      - name: 'push readme'
-        uses: 'clouddrove/[email protected]'
-        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/[email protected]
+    secrets:
+      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,16 +8,16 @@ jobs:
   tf-checks-basic-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-      working_directory: './_example/basic/'
+      working_directory: './examples/basic/'
   tf-checks-complete-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-      working_directory: './_example/complete/'
+      working_directory: './examples/complete/'
   tf-checks-only_rules-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-      working_directory: './_example/only_rules/'
+      working_directory: './examples/only_rules/'
   tf-checks-prefx_list-example:
     uses: clouddrove/github-shared-workflows/.github/workflows/[email protected]
     with:
-       working_directory: './_example/prefix_list/'
+       working_directory: './examples/prefix_list/'
diff --git a/README.yaml b/README.yaml
@@ -24,18 +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 1.5.4
+  - name: Terraform
     url: https://learn.hashicorp.com/terraform/getting-started/install.html
+    version: ">= 1.5.0"
+
+providers:
+  - name: aws
+    url: https://aws.amazon.com/
+    version: ">= 5.1.0"
+
+module_dependencies:
+  - name: Labels Module
+    url: https://github.com/clouddrove/terraform-aws-labels
+    description: Provides resource tagging.
+
 #  description of this project
 description: |-
   This terraform module creates set of Security Group and Security Group Rules resources in various combinations.
 
-# extra content
-include:
-  - "terraform.md"
-
 # How to use this project
 usage: |-
   Here are some examples of how you can use this module in your inventory structure:

diff --git a/_example/basic/example.tf → examples/basic/example.tf b/_example/basic/example.tf → examples/basic/example.tf
diff --git a/_example/basic/outputs.tf → examples/basic/outputs.tf b/_example/basic/outputs.tf → examples/basic/outputs.tf
diff --git a/_example/complete/example.tf → examples/complete/example.tf b/_example/complete/example.tf → examples/complete/example.tf
diff --git a/_example/complete/outputs.tf → examples/complete/outputs.tf b/_example/complete/outputs.tf → examples/complete/outputs.tf
diff --git a/_example/only_rules/example.tf → examples/only_rules/example.tf b/_example/only_rules/example.tf → examples/only_rules/example.tf
diff --git a/_example/prefix_list/example.tf → examples/prefix_list/example.tf b/_example/prefix_list/example.tf → examples/prefix_list/example.tf
diff --git a/_example/prefix_list/outputs.tf → examples/prefix_list/outputs.tf b/_example/prefix_list/outputs.tf → examples/prefix_list/outputs.tf