feat: updated readme parameters as per the latest template (#12)

.github/workflows/readme.yml

@@ -1,15 +1,33 @@
 name: 'Create README.md file'
+permissions: write-all
+
 on:
   push:
     branches:
       - master
+    paths-ignore:
+      - '**/*README.md'
+  workflow_dispatch:
+
 jobs:
-  readme:
+
+  readme-create:
+
     name: 'readme-create'
     runs-on: ubuntu-latest
+
     steps:
-      - name: 'Checkout'
+      - name: Updating GitHub Token
+        env: 
+          GITHUB_TOKEN: ${{ secrets.GITHUB }}
+        run: echo "GH_TOKEN=${GITHUB_TOKEN}" >> $GITHUB_ENV
+
+      - name: checkout
         uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+          token: ${{ env.GH_TOKEN }}
 
       - name: 'Set up Python 3.7'
         uses: actions/setup-python@v5
@@ -22,14 +40,15 @@ jobs:
           actions_subcommand: 'readme'
           github_token: '${{ secrets.GITHUB }}'
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB }}
+
 
       - name: 'pre-commit check errors'
-        uses: pre-commit/action@v3.0.0
+        uses: pre-commit/action@v3.0.1
         continue-on-error: true
 
       - name: 'pre-commit fix erros'
-        uses: pre-commit/action@v3.0.0
+        uses: pre-commit/action@v3.0.1
         continue-on-error: true
 
       - name: 'push readme'
@@ -38,7 +57,7 @@ jobs:
         with:
           actions_subcommand: 'push'
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB }}
 
       - name: 'Slack Notification'
         uses: clouddrove/action-slack@v2
@@ -47,6 +66,6 @@ jobs:
           fields: repo,author
           author_name: 'CloudDrove'
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # required
+          GITHUB_TOKEN: ${{ secrets.GITHUB }} # required
           SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_TERRAFORM }} # required
-        if: always()
+        if: always()

README.yaml

@@ -24,16 +24,31 @@ 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.4
+  - name: Terraform
     url: https://learn.hashicorp.com/terraform/getting-started/install.html
+    version: ">= 1.5.4"
+
+providers:
+  - name: digitalocean
+    url: https://www.digitalocean.com/
+    version: ">= 2.34.1"
+
 #  description of this project
 description: |-
   Terraform module to create Digitalocean app service resource on Digitalocean.
 # extra content
 include:
-  - "terraform.md"
+  - "docs/io.md"
+
+module_dependencies:
+  - name: Labels Module
+    url: https://github.com/clouddrove/terraform-aws-labels
+    description: Provides resource tagging.
 
 # How to use this project
 usage: |-