From 88147d6729252bbe8241f1c7e88212a85fd3a582 Mon Sep 17 00:00:00 2001 From: Tanveer <116706588+Tanveer143s@users.noreply.github.com> Date: Wed, 24 Apr 2024 14:17:16 +0530 Subject: [PATCH] feat: updated example path and readme parameters (#73) * feat: updated example path and readme parameters * feat- Updated Path for Ignore File --------- Co-authored-by: Vishwajit Nagulkar <119565952+VishwajitNagulkar@users.noreply.github.com> --- .github/dependabot.yml | 6 +- .github/workflows/readme.yml | 59 ++++--------------- .github/workflows/tf-checks.yml | 6 +- README.yaml | 15 +++-- .../ec2-network-mode-awsvpc/main.tf | 0 .../ec2-network-mode-awsvpc/outputs.tf | 0 .../td-ec2-awsvpc.json | 0 .../ec2-network-mode-awsvpc/versions.tf | 0 .../ec2-network-mode-bridge/main.tf | 0 .../ec2-network-mode-bridge/outputs.tf | 0 .../td-ec2-bridge.json | 0 .../ec2-network-mode-bridge/versions.tf | 0 {_example => examples}/fargate/main.tf | 0 {_example => examples}/fargate/outputs.tf | 0 .../fargate/td-fargate.json | 0 {_example => examples}/fargate/versions.tf | 0 16 files changed, 27 insertions(+), 59 deletions(-) rename {_example => examples}/ec2-network-mode-awsvpc/main.tf (100%) rename {_example => examples}/ec2-network-mode-awsvpc/outputs.tf (100%) rename {_example => examples}/ec2-network-mode-awsvpc/td-ec2-awsvpc.json (100%) rename {_example => examples}/ec2-network-mode-awsvpc/versions.tf (100%) rename {_example => examples}/ec2-network-mode-bridge/main.tf (100%) rename {_example => examples}/ec2-network-mode-bridge/outputs.tf (100%) rename {_example => examples}/ec2-network-mode-bridge/td-ec2-bridge.json (100%) rename {_example => examples}/ec2-network-mode-bridge/versions.tf (100%) rename {_example => examples}/fargate/main.tf (100%) rename {_example => examples}/fargate/outputs.tf (100%) rename {_example => examples}/fargate/td-fargate.json (100%) rename {_example => examples}/fargate/versions.tf (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 806f154..3e05a66 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -14,7 +14,7 @@ updates: reviewers: - "approvers" - package-ecosystem: "terraform" # See documentation for possible values - directory: "_example/ec2-network-mode-awsvpc" # Location of package manifests + directory: "examples/ec2-network-mode-awsvpc" # Location of package manifests schedule: interval: "weekly" # Add assignees @@ -24,7 +24,7 @@ updates: reviewers: - "approvers" - package-ecosystem: "terraform" # See documentation for possible values - directory: "_example/ec2-network-mode-bridge" # Location of package manifests + directory: "examples/ec2-network-mode-bridge" # Location of package manifests schedule: interval: "weekly" # Add assignees @@ -34,7 +34,7 @@ updates: reviewers: - "approvers" - package-ecosystem: "terraform" # See documentation for possible values - directory: "_example/fargate" # Location of package manifests + directory: "examples/fargate" # Location of package manifests schedule: interval: "weekly" # Add assignees diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 9961649..3d0c2f1 100644 --- 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: - 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 }} diff --git a/.github/workflows/tf-checks.yml b/.github/workflows/tf-checks.yml index 23c2569..61d2bf7 100644 --- a/.github/workflows/tf-checks.yml +++ b/.github/workflows/tf-checks.yml @@ -8,13 +8,13 @@ jobs: ec2-network-mode-awsvpc: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/ec2-network-mode-awsvpc/' + working_directory: './examples/ec2-network-mode-awsvpc/' ec2-network-mode-bridge: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/ec2-network-mode-bridge/' + working_directory: './examples/ec2-network-mode-bridge/' fargate: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/fargate/' + working_directory: './examples/fargate/' diff --git a/README.yaml b/README.yaml index 2e9fe47..9c2f5e5 100644 --- a/README.yaml +++ b/README.yaml @@ -24,18 +24,25 @@ 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" + # description of this project description: |- Terraform module to create ECS on AWS. -# extra content -include: - - "terraform.md" # How to use this project # How to use this project diff --git a/_example/ec2-network-mode-awsvpc/main.tf b/examples/ec2-network-mode-awsvpc/main.tf similarity index 100% rename from _example/ec2-network-mode-awsvpc/main.tf rename to examples/ec2-network-mode-awsvpc/main.tf diff --git a/_example/ec2-network-mode-awsvpc/outputs.tf b/examples/ec2-network-mode-awsvpc/outputs.tf similarity index 100% rename from _example/ec2-network-mode-awsvpc/outputs.tf rename to examples/ec2-network-mode-awsvpc/outputs.tf diff --git a/_example/ec2-network-mode-awsvpc/td-ec2-awsvpc.json b/examples/ec2-network-mode-awsvpc/td-ec2-awsvpc.json similarity index 100% rename from _example/ec2-network-mode-awsvpc/td-ec2-awsvpc.json rename to examples/ec2-network-mode-awsvpc/td-ec2-awsvpc.json diff --git a/_example/ec2-network-mode-awsvpc/versions.tf b/examples/ec2-network-mode-awsvpc/versions.tf similarity index 100% rename from _example/ec2-network-mode-awsvpc/versions.tf rename to examples/ec2-network-mode-awsvpc/versions.tf diff --git a/_example/ec2-network-mode-bridge/main.tf b/examples/ec2-network-mode-bridge/main.tf similarity index 100% rename from _example/ec2-network-mode-bridge/main.tf rename to examples/ec2-network-mode-bridge/main.tf diff --git a/_example/ec2-network-mode-bridge/outputs.tf b/examples/ec2-network-mode-bridge/outputs.tf similarity index 100% rename from _example/ec2-network-mode-bridge/outputs.tf rename to examples/ec2-network-mode-bridge/outputs.tf diff --git a/_example/ec2-network-mode-bridge/td-ec2-bridge.json b/examples/ec2-network-mode-bridge/td-ec2-bridge.json similarity index 100% rename from _example/ec2-network-mode-bridge/td-ec2-bridge.json rename to examples/ec2-network-mode-bridge/td-ec2-bridge.json diff --git a/_example/ec2-network-mode-bridge/versions.tf b/examples/ec2-network-mode-bridge/versions.tf similarity index 100% rename from _example/ec2-network-mode-bridge/versions.tf rename to examples/ec2-network-mode-bridge/versions.tf diff --git a/_example/fargate/main.tf b/examples/fargate/main.tf similarity index 100% rename from _example/fargate/main.tf rename to examples/fargate/main.tf diff --git a/_example/fargate/outputs.tf b/examples/fargate/outputs.tf similarity index 100% rename from _example/fargate/outputs.tf rename to examples/fargate/outputs.tf diff --git a/_example/fargate/td-fargate.json b/examples/fargate/td-fargate.json similarity index 100% rename from _example/fargate/td-fargate.json rename to examples/fargate/td-fargate.json diff --git a/_example/fargate/versions.tf b/examples/fargate/versions.tf similarity index 100% rename from _example/fargate/versions.tf rename to examples/fargate/versions.tf