From baf748adb622f1d6e1955830f36e741c5a525ebb Mon Sep 17 00:00:00 2001 From: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> Date: Fri, 12 Apr 2024 18:40:26 +0530 Subject: [PATCH 1/3] feat: updated example path and readme paramters --- .github/workflows/automerge.yml | 2 +- .github/workflows/readme.yml | 58 +++---------------- .github/workflows/tf-checks.yml | 6 +- README.yaml | 20 +++++-- {_example => examples}/basic/example.tf | 0 {_example => examples}/basic/outputs.tf | 0 {_example => examples}/basic/versions.tf | 0 {_example => examples}/complete/example.tf | 0 {_example => examples}/complete/outputs.tf | 0 {_example => examples}/complete/user-data.sh | 0 {_example => examples}/complete/versions.tf | 0 .../spot_instance/example.tf | 0 .../spot_instance/outputs.tf | 0 .../spot_instance/versions.tf | 0 14 files changed, 28 insertions(+), 58 deletions(-) rename {_example => examples}/basic/example.tf (100%) rename {_example => examples}/basic/outputs.tf (100%) rename {_example => examples}/basic/versions.tf (100%) rename {_example => examples}/complete/example.tf (100%) rename {_example => examples}/complete/outputs.tf (100%) rename {_example => examples}/complete/user-data.sh (100%) rename {_example => examples}/complete/versions.tf (100%) rename {_example => examples}/spot_instance/example.tf (100%) rename {_example => examples}/spot_instance/outputs.tf (100%) rename {_example => examples}/spot_instance/versions.tf (100%) diff --git a/.github/workflows/automerge.yml b/.github/workflows/automerge.yml index 458fd7b..676d957 100644 --- a/.github/workflows/automerge.yml +++ b/.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' ... diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 2e4b3d0..9bb5230 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -1,54 +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 }} \ No newline at end of file diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml index 8510df6..a327a16 100644 --- a/.github/workflows/tf-checks.yml +++ b/.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/' ... diff --git a/README.yaml b/README.yaml index a277b5e..cdef558 100644 --- a/README.yaml +++ b/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: |- diff --git a/_example/basic/example.tf b/examples/basic/example.tf similarity index 100% rename from _example/basic/example.tf rename to examples/basic/example.tf diff --git a/_example/basic/outputs.tf b/examples/basic/outputs.tf similarity index 100% rename from _example/basic/outputs.tf rename to examples/basic/outputs.tf diff --git a/_example/basic/versions.tf b/examples/basic/versions.tf similarity index 100% rename from _example/basic/versions.tf rename to examples/basic/versions.tf diff --git a/_example/complete/example.tf b/examples/complete/example.tf similarity index 100% rename from _example/complete/example.tf rename to examples/complete/example.tf diff --git a/_example/complete/outputs.tf b/examples/complete/outputs.tf similarity index 100% rename from _example/complete/outputs.tf rename to examples/complete/outputs.tf diff --git a/_example/complete/user-data.sh b/examples/complete/user-data.sh similarity index 100% rename from _example/complete/user-data.sh rename to examples/complete/user-data.sh diff --git a/_example/complete/versions.tf b/examples/complete/versions.tf similarity index 100% rename from _example/complete/versions.tf rename to examples/complete/versions.tf diff --git a/_example/spot_instance/example.tf b/examples/spot_instance/example.tf similarity index 100% rename from _example/spot_instance/example.tf rename to examples/spot_instance/example.tf diff --git a/_example/spot_instance/outputs.tf b/examples/spot_instance/outputs.tf similarity index 100% rename from _example/spot_instance/outputs.tf rename to examples/spot_instance/outputs.tf diff --git a/_example/spot_instance/versions.tf b/examples/spot_instance/versions.tf similarity index 100% rename from _example/spot_instance/versions.tf rename to examples/spot_instance/versions.tf From 599665a0dd96173f87bbd391cffb22382ee3d527 Mon Sep 17 00:00:00 2001 From: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> Date: Fri, 12 Apr 2024 18:54:03 +0530 Subject: [PATCH 2/3] feat: updated readme path --- .github/dependabot.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 46700b6..0619e21 100644 --- a/.github/dependabot.yml +++ b/.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 From 37176319d6c7830eb73d729ea2950d0300d70081 Mon Sep 17 00:00:00 2001 From: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> Date: Thu, 25 Apr 2024 15:49:13 +0530 Subject: [PATCH 3/3] feat- added path for ignore file in GHA --- .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 }}