From 346b7585215efdee6d459232dc2df3fb4b6625b7 Mon Sep 17 00:00:00 2001 From: Tanveer <116706588+Tanveer143s@users.noreply.github.com> Date: Tue, 16 Apr 2024 20:34:14 +0530 Subject: [PATCH 1/2] feat: updated example path and readme paramters --- .github/dependabot.yml | 6 +- .github/workflows/readme.yml | 57 +++---------------- .github/workflows/tf-checks.yml | 6 +- README.yaml | 22 +++++-- .../anomaly_example/_bin/user_data.sh | 0 .../anomaly_example/example.tf | 0 .../anomaly_example/outputs.tf | 0 .../anomaly_example/versions.tf | 0 .../basic_example/_bin/user_data.sh | 0 .../basic_example/example.tf | 0 .../basic_example/outputs.tf | 0 .../basic_example/versions.tf | 0 .../expression_example/_bin/user_data.sh | 0 .../expression_example/example.tf | 0 .../expression_example/outputs.tf | 0 .../expression_example/versions.tf | 0 16 files changed, 33 insertions(+), 58 deletions(-) rename {_example => examples}/anomaly_example/_bin/user_data.sh (100%) rename {_example => examples}/anomaly_example/example.tf (100%) rename {_example => examples}/anomaly_example/outputs.tf (100%) rename {_example => examples}/anomaly_example/versions.tf (100%) rename {_example => examples}/basic_example/_bin/user_data.sh (100%) rename {_example => examples}/basic_example/example.tf (100%) rename {_example => examples}/basic_example/outputs.tf (100%) rename {_example => examples}/basic_example/versions.tf (100%) rename {_example => examples}/expression_example/_bin/user_data.sh (100%) rename {_example => examples}/expression_example/example.tf (100%) rename {_example => examples}/expression_example/outputs.tf (100%) rename {_example => examples}/expression_example/versions.tf (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index be67b30..6d4a43c 100644 --- a/.github/dependabot.yml +++ b/.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 diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 2ff513e..9bb5230 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -1,53 +1,14 @@ -name: 'Create README.md file' +name: Readme Workflow on: push: branches: - master + paths-ignore: + - 'README.md' + 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 }} \ No newline at end of file diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml index aecac2a..c661835 100644 --- a/.github/workflows/tf-checks.yml +++ b/.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/' diff --git a/README.yaml b/README.yaml index 20aede0..ab4e8c3 100644 --- a/README.yaml +++ b/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: |- diff --git a/_example/anomaly_example/_bin/user_data.sh b/examples/anomaly_example/_bin/user_data.sh similarity index 100% rename from _example/anomaly_example/_bin/user_data.sh rename to examples/anomaly_example/_bin/user_data.sh diff --git a/_example/anomaly_example/example.tf b/examples/anomaly_example/example.tf similarity index 100% rename from _example/anomaly_example/example.tf rename to examples/anomaly_example/example.tf diff --git a/_example/anomaly_example/outputs.tf b/examples/anomaly_example/outputs.tf similarity index 100% rename from _example/anomaly_example/outputs.tf rename to examples/anomaly_example/outputs.tf diff --git a/_example/anomaly_example/versions.tf b/examples/anomaly_example/versions.tf similarity index 100% rename from _example/anomaly_example/versions.tf rename to examples/anomaly_example/versions.tf diff --git a/_example/basic_example/_bin/user_data.sh b/examples/basic_example/_bin/user_data.sh similarity index 100% rename from _example/basic_example/_bin/user_data.sh rename to examples/basic_example/_bin/user_data.sh diff --git a/_example/basic_example/example.tf b/examples/basic_example/example.tf similarity index 100% rename from _example/basic_example/example.tf rename to examples/basic_example/example.tf diff --git a/_example/basic_example/outputs.tf b/examples/basic_example/outputs.tf similarity index 100% rename from _example/basic_example/outputs.tf rename to examples/basic_example/outputs.tf diff --git a/_example/basic_example/versions.tf b/examples/basic_example/versions.tf similarity index 100% rename from _example/basic_example/versions.tf rename to examples/basic_example/versions.tf diff --git a/_example/expression_example/_bin/user_data.sh b/examples/expression_example/_bin/user_data.sh similarity index 100% rename from _example/expression_example/_bin/user_data.sh rename to examples/expression_example/_bin/user_data.sh diff --git a/_example/expression_example/example.tf b/examples/expression_example/example.tf similarity index 100% rename from _example/expression_example/example.tf rename to examples/expression_example/example.tf diff --git a/_example/expression_example/outputs.tf b/examples/expression_example/outputs.tf similarity index 100% rename from _example/expression_example/outputs.tf rename to examples/expression_example/outputs.tf diff --git a/_example/expression_example/versions.tf b/examples/expression_example/versions.tf similarity index 100% rename from _example/expression_example/versions.tf rename to examples/expression_example/versions.tf From 1a7469e53a3852f35a1a84880a74e888937152cd Mon Sep 17 00:00:00 2001 From: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> Date: Wed, 24 Apr 2024 13:52:27 +0530 Subject: [PATCH 2/2] feat- Updated Path for Ignore File --- .github/workflows/readme.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 9bb5230..3d0c2f1 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -5,10 +5,11 @@ on: - master paths-ignore: - 'README.md' + - 'docs/**' workflow_dispatch: jobs: 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 + SLACK_WEBHOOK_TERRAFORM: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }}