From 9dabbd86e3c0f2796e36d20f91ae243b677e5e78 Mon Sep 17 00:00:00 2001 From: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> Date: Fri, 12 Apr 2024 22:53:42 +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 +++++++--- {_example => examples}/alb/example.tf | 0 {_example => examples}/alb/outputs.tf | 0 {_example => examples}/alb/versions.tf | 0 {_example => examples}/clb/example.tf | 0 {_example => examples}/clb/outputs.tf | 0 {_example => examples}/clb/versions.tf | 0 {_example => examples}/nlb/example.tf | 0 {_example => examples}/nlb/outputs.tf | 0 {_example => examples}/nlb/versions.tf | 0 13 files changed, 32 insertions(+), 59 deletions(-) rename {_example => examples}/alb/example.tf (100%) rename {_example => examples}/alb/outputs.tf (100%) rename {_example => examples}/alb/versions.tf (100%) rename {_example => examples}/clb/example.tf (100%) rename {_example => examples}/clb/outputs.tf (100%) rename {_example => examples}/clb/versions.tf (100%) rename {_example => examples}/nlb/example.tf (100%) rename {_example => examples}/nlb/outputs.tf (100%) rename {_example => examples}/nlb/versions.tf (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index bc8196f..cd8d346 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -30,7 +30,7 @@ updates: open-pull-requests-limit: 3 - package-ecosystem: "terraform" # See documentation for possible values - directory: "/_example/alb" # Location of package manifests + directory: "/examples/alb" # Location of package manifests schedule: interval: "weekly" # Add assignees @@ -43,7 +43,7 @@ updates: open-pull-requests-limit: 3 - package-ecosystem: "terraform" # See documentation for possible values - directory: "/_example/clb" # Location of package manifests + directory: "/examples/clb" # Location of package manifests schedule: interval: "weekly" # Add assignees @@ -56,7 +56,7 @@ updates: open-pull-requests-limit: 3 - package-ecosystem: "terraform" # See documentation for possible values - directory: "/_example/nlb" # Location of package manifests + directory: "/examples/nlb" # Location of package manifests schedule: interval: "weekly" # Add assignees diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 95e527b..8b6ceaa 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@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 }} diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml index 02d66a7..751c988 100644 --- a/.github/workflows/tf-checks.yml +++ b/.github/workflows/tf-checks.yml @@ -9,13 +9,13 @@ jobs: alb: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.4 with: - working_directory: './_example/alb/' + working_directory: './examples/alb/' nlb: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.4 with: - working_directory: './_example/nlb/' + working_directory: './examples/nlb/' clb: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.2.4 with: - working_directory: './_example/clb/' + working_directory: './examples/clb/' ... diff --git a/README.yaml b/README.yaml index 44fa851..1ac26a9 100644 --- a/README.yaml +++ b/README.yaml @@ -24,18 +24,30 @@ 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.3 + - 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: |- This terraform module is used to create ALB on AWS. -# extra content -include: - - "terraform.md" - # How to use this project usage : |- Here are examples of how you can use this module in your inventory structure: diff --git a/_example/alb/example.tf b/examples/alb/example.tf similarity index 100% rename from _example/alb/example.tf rename to examples/alb/example.tf diff --git a/_example/alb/outputs.tf b/examples/alb/outputs.tf similarity index 100% rename from _example/alb/outputs.tf rename to examples/alb/outputs.tf diff --git a/_example/alb/versions.tf b/examples/alb/versions.tf similarity index 100% rename from _example/alb/versions.tf rename to examples/alb/versions.tf diff --git a/_example/clb/example.tf b/examples/clb/example.tf similarity index 100% rename from _example/clb/example.tf rename to examples/clb/example.tf diff --git a/_example/clb/outputs.tf b/examples/clb/outputs.tf similarity index 100% rename from _example/clb/outputs.tf rename to examples/clb/outputs.tf diff --git a/_example/clb/versions.tf b/examples/clb/versions.tf similarity index 100% rename from _example/clb/versions.tf rename to examples/clb/versions.tf diff --git a/_example/nlb/example.tf b/examples/nlb/example.tf similarity index 100% rename from _example/nlb/example.tf rename to examples/nlb/example.tf diff --git a/_example/nlb/outputs.tf b/examples/nlb/outputs.tf similarity index 100% rename from _example/nlb/outputs.tf rename to examples/nlb/outputs.tf diff --git a/_example/nlb/versions.tf b/examples/nlb/versions.tf similarity index 100% rename from _example/nlb/versions.tf rename to examples/nlb/versions.tf From a7dfad7842954f56ed79295e92442fb931bd8e6c Mon Sep 17 00:00:00 2001 From: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> Date: Thu, 25 Apr 2024 15:35:22 +0530 Subject: [PATCH 2/2] feat- added path for ignore file in GHA --- .github/workflows/readme.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 8b6ceaa..3d0c2f1 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -5,6 +5,7 @@ on: - master paths-ignore: - 'README.md' + - 'docs/**' workflow_dispatch: jobs: README: