ci: update workflow

Author: nimisha-gj

.github/workflows/documentation.yaml

@@ -22,11 +22,6 @@ jobs:
           output-method: replace
           git-push: true
 
-      - name: Ensure newline at end of README files
-        run: |
-          find . -type f -name 'README.md' -exec sh -c 'echo >> "{}"' \;
-        working-directory: ${{ github.workspace }}
-
       - name: Commit changes
         run: |
           git config --local user.email "action@github.com"

.github/workflows/pre-commit.yaml

@@ -15,6 +15,34 @@ env:
   TFLINT_VERSION: v0.50.3
 
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Render terraform docs and push changes back to PR
+        uses: terraform-docs/gh-actions@main
+        with:
+          working-dir: .
+          recursive: true
+          recursive-path: modules
+          output-file: README.md
+          output-method: replace
+          git-push: true
+
+      - name: Commit changes
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add .
+          git commit -m "Fix newline at end of README.md files"
+          git push origin ${{ github.event.pull_request.head.ref }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   collectInputs:
     name: Collect workflow inputs
     runs-on: ubuntu-latest

.pre-commit-config.yaml

@@ -3,9 +3,6 @@ repos:
     rev: v1.89.0
     hooks:
       - id: terraform_fmt
-      - id: terraform_docs
-        args:
-          - '--args=--lockfile=false'
       - id: terraform_tflint
         args:
           - '--args=--only=terraform_deprecated_interpolation'

modules/account_users_and_groups_assignments/README.md

@@ -14,8 +14,8 @@ A Terraform module for assigning users and groups to AWS accounts.
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.59.0 |
-| <a name="provider_null"></a> [null](#provider\_null) | 3.2.2 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.59.0 |
+| <a name="provider_null"></a> [null](#provider\_null) | ~> 3.2.2 |
 
 ## Modules