Merge pull request #106 from schubergphilis/docs-fix

fix the docs generation

Author: marwinbaumannsbp

sync-root/.github/workflows/label-synchronization.yaml

@@ -1,3 +1,6 @@
+# DO NOT CHANGE THIS FILE DIRECTLY
+# Source: https://github.com/schubergphilis/mcaf-github-workflows
+
 name: label-synchronization
 on:
   workflow_dispatch:

sync-root/.github/workflows/pr-validation.yaml

@@ -1,3 +1,6 @@
+# DO NOT CHANGE THIS FILE DIRECTLY
+# Source: https://github.com/schubergphilis/mcaf-github-workflows
+
 name: "pr-validation"
 
 on:

sync-root/.github/workflows/release-drafter.yaml

@@ -1,3 +1,6 @@
+# DO NOT CHANGE THIS FILE DIRECTLY
+# Source: https://github.com/schubergphilis/mcaf-github-workflows
+
 name: "release-drafter"
 
 on:

sync-root/.github/workflows/terraform-validation.yaml

@@ -1,3 +1,6 @@
+# DO NOT CHANGE THIS FILE DIRECTLY
+# Source: https://github.com/schubergphilis/mcaf-github-workflows
+
 name: "terraform"
 
 on:
@@ -116,14 +119,36 @@ jobs:
       - name: Render terraform docs inside the README.md and push changes back to PR branch
         uses: terraform-docs/gh-actions@v1.3.0
         with:
-          args: --sort-by required --recursive
+          args: --sort-by required
           git-commit-message: "docs(readme): update module usage"
           git-push: true
           output-file: README.md
           output-method: inject
           working-dir: .
         continue-on-error: true # added this to prevent a PR from a remote fork failing the workflow
 
+  # If the recursive flag is set to true, the action will not update the main README.md file. 
+  # Therefore we need to run the action twice, once for the root module and once for the modules directory
+  docs-modules:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+
+      - name: Render terraform docs inside the README.md and push changes back to PR branch
+        uses: terraform-docs/gh-actions@v1.3.0
+        with:
+          args: --sort-by required
+          git-commit-message: "docs(readme): update module usage"
+          git-push: true
+          output-file: README.md
+          output-method: inject
+          recursive-path: modules
+          recursive: true
+          working-dir: .
+        continue-on-error: true # added this to prevent a PR from a remote fork failing the workflow
 
   checkov:
     runs-on: ubuntu-latest

sync-root/.github/workflows/update-changelog.yaml

@@ -1,3 +1,6 @@
+# DO NOT CHANGE THIS FILE DIRECTLY
+# Source: https://github.com/schubergphilis/mcaf-github-workflows
+
 name: "update-changelog"
 
 on:

sync-root/.pre-commit-config.yaml

@@ -1,4 +1,5 @@
-# .pre-commit-config.yaml
+# DO NOT CHANGE THIS FILE DIRECTLY
+# Source: https://github.com/schubergphilis/mcaf-github-workflows
 default_stages: [pre-commit]
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks