Merge pull request #18 from descomplicando-terraform/tf_docs

feat(ci): add terraform docs on pr

.github/workflows/tf_checks.yml

@@ -45,6 +45,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
 
       - name: Set up Terraform
         uses: hashicorp/setup-terraform@v2
@@ -53,4 +55,12 @@ jobs:
         run: terraform init -backend=false
 
       - name: Run terraform validate
-        run: terraform validate
+        run: terraform validate
+
+      - name: Render terraform docs inside the README.md and push changes back to PR branch
+        uses: terraform-docs/[email protected]
+        with:
+          working-dir: .
+          output-file: README.md
+          output-method: inject
+          git-push: "true"