Merge pull request #4 from chris-qa-org/add-github-action-to-generate-terraform-docs

Add GitHub action to generate Terraform docs

Author: Stretch96

.github/workflows/main.yml

@@ -40,3 +40,19 @@ jobs:
       with:
         entrypoint: terraform
         args: fmt -check=true -diff=true
+  generate-terraform-docs:
+    needs: validate
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Generate Terraform docs
+        uses: terraform-docs/[email protected]
+        with:
+          working-dir: .
+          config-file: .terraform-docs.yml
+          git-push: true
+          git-commit-message: "GitHub Action: Generate terraform docs"

USAGE.md

@@ -0,0 +1,7 @@
+# Usage
+
+<!--- BEGIN_TF_DOCS --->
+README.md updated successfully
+
+<!--- END_TF_DOCS --->
+