From a207fc968c35614208249b28e2191833e5968f63 Mon Sep 17 00:00:00 2001 From: Tanveer <116706588+Tanveer143s@users.noreply.github.com> Date: Fri, 26 Apr 2024 16:29:40 +0530 Subject: [PATCH] feat: updated example path and readme paramters --- .github/dependabot.yml | 6 +- .github/workflows/readme.yml | 59 ++++--------------- .github/workflows/tf-checks.yml | 8 +-- README.yaml | 37 ++++++++---- .../private-hostedzone/example.tf | 0 .../private-hostedzone/outputs.tf | 0 .../private-hostedzone/versions.tf | 0 .../public-hostedzone/example.tf | 0 .../public-hostedzone/outputs.tf | 0 .../public-hostedzone/versions.tf | 0 {_example => examples}/records/data.tf | 0 {_example => examples}/records/example.tf | 0 {_example => examples}/records/outputs.tf | 0 {_example => examples}/records/versions.tf | 0 .../vpc-association/example.tf | 0 .../vpc-association/outputs.tf | 0 .../vpc-association/versions.tf | 0 17 files changed, 42 insertions(+), 68 deletions(-) rename {_example => examples}/private-hostedzone/example.tf (100%) rename {_example => examples}/private-hostedzone/outputs.tf (100%) rename {_example => examples}/private-hostedzone/versions.tf (100%) rename {_example => examples}/public-hostedzone/example.tf (100%) rename {_example => examples}/public-hostedzone/outputs.tf (100%) rename {_example => examples}/public-hostedzone/versions.tf (100%) rename {_example => examples}/records/data.tf (100%) rename {_example => examples}/records/example.tf (100%) rename {_example => examples}/records/outputs.tf (100%) rename {_example => examples}/records/versions.tf (100%) rename {_example => examples}/vpc-association/example.tf (100%) rename {_example => examples}/vpc-association/outputs.tf (100%) rename {_example => examples}/vpc-association/versions.tf (100%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 52db465..28b2652 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -16,7 +16,7 @@ updates: reviewers: - "approvers" - package-ecosystem: "terraform" # See documentation for possible values - directory: "_example/private-hostedzone" # Location of package manifests + directory: "examples/private-hostedzone" # Location of package manifests schedule: interval: "weekly" # Add assignees @@ -26,7 +26,7 @@ updates: reviewers: - "approvers" - package-ecosystem: "terraform" # See documentation for possible values - directory: "_example/public-hostedzone" # Location of package manifests + directory: "examples/public-hostedzone" # Location of package manifests schedule: interval: "weekly" # Add assignees @@ -36,7 +36,7 @@ updates: reviewers: - "approvers" - package-ecosystem: "terraform" # See documentation for possible values - directory: "_example/vpc-association" # Location of package manifests + directory: "examples/vpc-association" # Location of package manifests schedule: interval: "weekly" # Add assignees diff --git a/.github/workflows/readme.yml b/.github/workflows/readme.yml index 1eb0243..7f6aaec 100644 --- a/.github/workflows/readme.yml +++ b/.github/workflows/readme.yml @@ -1,53 +1,16 @@ -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/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.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@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 540c82a..fd50e60 100644 --- a/.github/workflows/tf-checks.yml +++ b/.github/workflows/tf-checks.yml @@ -8,16 +8,16 @@ jobs: private-hostedzone: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/private-hostedzone/' + working_directory: './examples/private-hostedzone/' public-hostedzone: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/public-hostedzone/' + working_directory: './examples/public-hostedzone/' records: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/records/' + working_directory: './examples/records/' vpc-association: uses: clouddrove/github-shared-workflows/.github/workflows/tf-checks.yml@1.0.9 with: - working_directory: './_example/vpc-association/' + working_directory: './examples/vpc-association/' diff --git a/README.yaml b/README.yaml index 8580642..2d9ec5d 100644 --- a/README.yaml +++ b/README.yaml @@ -15,28 +15,39 @@ github_repo: clouddrove/terraform-aws-route53 # Badges to display badges: - - name: "Terraform" - image: "https://img.shields.io/badge/terraform-v1.1.7-green" - url: "https://www.terraform.io" - - name: "Licence" - image: "https://img.shields.io/badge/License-APACHE-blue.svg" - url: "LICENSE.md" + - name: "Latest Release" + image: "https://img.shields.io/github/release/clouddrove/terraform-aws-route53.svg" + url: "https://github.com/clouddrove/terraform-aws-route53/releases/latest" - name: "tfsec" image: "https://github.com/clouddrove/terraform-aws-route53/actions/workflows/tfsec.yml/badge.svg" url: "https://github.com/clouddrove/terraform-aws-route53/actions/workflows/tfsec.yml" - - name: "static-checks" - image: "https://github.com/clouddrove/terraform-aws-route53/actions/workflows/terraform.yml/badge.svg" - url: "https://github.com/clouddrove/terraform-aws-route53/actions/workflows/terraform.yml" + - 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.31.0" + +module_dependencies: + - name: Labels Module + url: https://github.com/clouddrove/terraform-aws-labels + description: Provides resource tagging. # description of this project # yamllint disable rule:line-length description: |- Terraform module to create Route53 resource on AWS for zone and record set. -# extra content -# please not remove these two If you need add more -include: - - "terraform.md" # How to use this project # yamllint disable rule:line-length diff --git a/_example/private-hostedzone/example.tf b/examples/private-hostedzone/example.tf similarity index 100% rename from _example/private-hostedzone/example.tf rename to examples/private-hostedzone/example.tf diff --git a/_example/private-hostedzone/outputs.tf b/examples/private-hostedzone/outputs.tf similarity index 100% rename from _example/private-hostedzone/outputs.tf rename to examples/private-hostedzone/outputs.tf diff --git a/_example/private-hostedzone/versions.tf b/examples/private-hostedzone/versions.tf similarity index 100% rename from _example/private-hostedzone/versions.tf rename to examples/private-hostedzone/versions.tf diff --git a/_example/public-hostedzone/example.tf b/examples/public-hostedzone/example.tf similarity index 100% rename from _example/public-hostedzone/example.tf rename to examples/public-hostedzone/example.tf diff --git a/_example/public-hostedzone/outputs.tf b/examples/public-hostedzone/outputs.tf similarity index 100% rename from _example/public-hostedzone/outputs.tf rename to examples/public-hostedzone/outputs.tf diff --git a/_example/public-hostedzone/versions.tf b/examples/public-hostedzone/versions.tf similarity index 100% rename from _example/public-hostedzone/versions.tf rename to examples/public-hostedzone/versions.tf diff --git a/_example/records/data.tf b/examples/records/data.tf similarity index 100% rename from _example/records/data.tf rename to examples/records/data.tf diff --git a/_example/records/example.tf b/examples/records/example.tf similarity index 100% rename from _example/records/example.tf rename to examples/records/example.tf diff --git a/_example/records/outputs.tf b/examples/records/outputs.tf similarity index 100% rename from _example/records/outputs.tf rename to examples/records/outputs.tf diff --git a/_example/records/versions.tf b/examples/records/versions.tf similarity index 100% rename from _example/records/versions.tf rename to examples/records/versions.tf diff --git a/_example/vpc-association/example.tf b/examples/vpc-association/example.tf similarity index 100% rename from _example/vpc-association/example.tf rename to examples/vpc-association/example.tf diff --git a/_example/vpc-association/outputs.tf b/examples/vpc-association/outputs.tf similarity index 100% rename from _example/vpc-association/outputs.tf rename to examples/vpc-association/outputs.tf diff --git a/_example/vpc-association/versions.tf b/examples/vpc-association/versions.tf similarity index 100% rename from _example/vpc-association/versions.tf rename to examples/vpc-association/versions.tf