Add command to generate README in Atmos config (#229)

* Add command to generate README in Atmos config

* Add readme command to GitHub Action configuration

* Add 'readme' command to terraform-module.yaml

* Upgrade readme action to version 2

Author: goruha

.github/atmos/default.yaml

@@ -17,3 +17,8 @@ docs:
         sort_by: "name"
         hide_empty: false
         indent_level: 2
+
+commands:
+- name: readme
+  steps:
+    - "atmos docs generate readme"

.github/atmos/github-action.yaml

@@ -7,3 +7,8 @@ docs:
         - "./README.yaml"
       template: "https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/README.md.gotmpl"
       output: "./README.md"
+
+commands:
+- name: readme
+  steps:
+    - "atmos docs generate readme"

.github/atmos/terraform-module.yaml

@@ -19,6 +19,10 @@ docs:
         indent_level: 2
 
 commands:
+- name: readme
+  steps:
+    - "atmos docs generate readme"
+
 - name: test
   commands:
   - name: "init"

.github/workflows/shared-readme.yml

@@ -38,11 +38,17 @@ jobs:
           fetch-depth: 0
           token: ${{ steps.github-app.outputs.token }}
 
-      - uses: cloudposse-github-actions/readme@v1
+      - uses: cloudposse-github-actions/readme@v2
+        id: readme
         with:
           token: ${{ steps.github-app.outputs.token }}
           readme_enabled: true
           banner_enabled: true
           validate_readme: true
           commit_method: 'commit'
           commit_push_options: '--force-with-lease'
+          command: readme
+          sign-commits: true
+          
+      - run: |-
+          echo "${{ steps.readme.outputs.changes_detected }}"