Update migration readme script to remove includes (#179)

* Added readme script

* Update shared-readme.yml

* Update shared-readme.yml

* Create shared-atmos-readme.yaml

* Update shared-terraform-module.yml

* Rename shared-atmos-readme.yaml to shared-atmos-readme.yml

* Update shared-terraform-module.yml

Author: goruha

.github/workflows/shared-atmos-readme.yml

@@ -0,0 +1,48 @@
+name: CI - Atmos Readme
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: "Checkout ref"
+        type: string
+        required: false
+        default: ${{ github.ref_name }}
+      repository:
+        description: "Checkout repository"
+        type: string
+        required: false
+        default: ${{ github.repository }}
+      runs-on:
+        description: "Overrides job runs-on setting (json-encoded list)"
+        type: string
+        required: false
+        default: '["ubuntu-latest"]'
+
+jobs:
+  validate:
+    runs-on: ${{ fromJSON(inputs.runs-on) }}
+    name: "Readme"
+    environment: release
+    steps:
+      - uses: actions/create-github-app-token@v1
+        id: github-app
+        with:
+          app-id: ${{ vars.BOT_GITHUB_APP_ID }}
+          private-key: ${{ secrets.BOT_GITHUB_APP_PRIVATE_KEY }}
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          repository: ${{ inputs.repository }}
+          fetch-depth: 0
+          token: ${{ steps.github-app.outputs.token }}
+
+      - uses: cloudposse-github-actions/readme@v1
+        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'

.github/workflows/shared-terraform-module.yml

@@ -24,7 +24,7 @@ jobs:
       runs-on: ${{ inputs.runs-on }}
 
   ci-readme:
-    uses: cloudposse/.github/.github/workflows/shared-readme.yml@main
+    uses: cloudposse/.github/.github/workflows/shared-atmos-readme.yml@main
     name: "Readme"
     if: ${{ github.event_name == 'push' }}
     with:

migrate/lib/readme.py

@@ -87,6 +87,17 @@ def migrate_readme(readme_yaml="README.yaml"):
         # Set 'contributors' section to an empty array, as we handle this now with an image
         data['contributors'] = []
 
+        if 'include' in data and isinstance(data['include'], list):
+            # Remove deprecated includes
+            include_to_remove = ['docs/terraform.md', 'docs/targets.md', 'docs/github-action.md']
+            data['include'] = [
+                file
+                for file in data['include']
+                if file not in include_to_remove
+            ]
+        else:
+            data['include'] = []
+
         add_newlines_before_comments(data)
 
     # Write back the updated YAML with multiple documents

migrate/migrations/20250523/script.sh

@@ -1,6 +1,9 @@
 title "Replace Makefile with atmos.yaml"
 
 remove Makefile
+remove docs/terraform.md
+remove docs/targets.md
+migrate_readme
 install atmos.yaml
 
 # Merge the PR