Use atmos instead of makefile (#230)

goruha · web-flow · commit 88b91d44bccf · 2025-09-17T18:26:22.000+03:00
* Added atmos readme

* Added migration

* Replace YQ with sed

* Remove includes docs/github-action.md and docs/target.md from README.yaml as atmos generate it on fly

* Remove github-action-atmos-dependencies-test GHA
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@
 
 .build-harness
 build-harness
+.atmos
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -2,8 +2,11 @@
 
 <!-- markdownlint-disable -->
 <a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/.github/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/>
-    <p align="right">
-<a href="https://github.com/cloudposse/.github/commits/main/"><img src="https://img.shields.io/github/last-commit/cloudposse/.github/main?style=for-the-badge" alt="Last Update"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>
+
+
+<p align="right"><a href="https://github.com/cloudposse/.github/commits/main/"><img src="https://img.shields.io/github/last-commit/cloudposse/.github/main?style=for-the-badge" alt="Last Update"/></a><a href="https://cloudposse.com/slack"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a><a href="https://cloudposse.com/support/"><img src="https://img.shields.io/badge/Get_Support-success.svg?style=for-the-badge" alt="Get Support"/></a>
+
+</p>
 <!-- markdownlint-restore -->
 
 <!--
@@ -64,6 +67,10 @@ To add all repository bootstrapping files to a new repo:
 
 
 
+
+
+
+
 ## ✨ Contributing
 
 This project is under active development, and we encourage contributions from our community.
@@ -88,6 +95,38 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
 
 **NOTE:** Be sure to merge the latest changes from "upstream" before making a pull request!
 
+
+## Running Terraform Tests
+
+We use [Atmos](https://atmos.tools) to streamline how Terraform tests are run. It centralizes configuration and wraps common test workflows with easy-to-use commands.
+
+All tests are located in the [`test/`](test) folder.
+
+Under the hood, tests are powered by Terratest together with our internal [Test Helpers](https://github.com/cloudposse/test-helpers) library, providing robust infrastructure validation.
+
+Setup dependencies:
+- Install Atmos ([installation guide](https://atmos.tools/install/))
+- Install Go [1.24+ or newer](https://go.dev/doc/install)
+- Install Terraform or OpenTofu
+
+To run tests:
+
+- Run all tests:  
+  ```sh
+  atmos test run
+  ```
+- Clean up test artifacts:  
+  ```sh
+  atmos test clean
+  ```
+- Explore additional test options:  
+  ```sh
+  atmos test --help
+  ```
+The configuration for test commands is centrally managed. To review what's being imported, see the [`atmos.yaml`](https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/terraform-module.yaml) file.
+
+Learn more about our [automated testing in our documentation](https://docs.cloudposse.com/community/contribute/automated-testing/) or implementing [custom commands](https://atmos.tools/core-concepts/custom-commands/) with atmos.
+
 ### 🌎 Slack Community
 
 Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/.github&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
@@ -139,7 +178,7 @@ All other trademarks referenced herein are the property of their respective owne
 
 ## Copyrights
 
-Copyright © 2022-2024 [Cloud Posse, LLC](https://cloudposse.com)
+Copyright © 2022-2025 [Cloud Posse, LLC](https://cloudposse.com)
 
 
 
diff --git a/atmos.yaml b/atmos.yaml
@@ -0,0 +1,12 @@
+# Atmos Configuration — powered by https://atmos.tools
+#
+# This configuration enables centralized, DRY, and consistent project scaffolding using Atmos.
+#
+# Included features:
+# - Organizational custom commands: https://atmos.tools/core-concepts/custom-commands
+# - Automated README generation: https://atmos.tools/cli/commands/docs/generate
+#
+
+# Import shared configuration used by all modules
+import:
+  - https://raw.githubusercontent.com/cloudposse/.github/refs/heads/main/.github/atmos/default.yaml
diff --git a/docs/.gitkeep b/docs/.gitkeep
diff --git a/docs/targets.md b/docs/targets.md
diff --git a/docs/terraform.md b/docs/terraform.md
diff --git a/migrate/migrations/20250915/README.md b/migrate/migrations/20250915/README.md
@@ -0,0 +1,9 @@
+## what
+- Remove `Makefile`
+- Add `atmos.yaml`
+
+## why
+- Replace `build-harness` with `atmos` for readme genration
+
+## References
+* DEV-3229 Migrate from build-harness to atmos
diff --git a/migrate/migrations/20250915/repos-00 b/migrate/migrations/20250915/repos-00
@@ -0,0 +1,16 @@
+cloudposse/github-action-datadog-notify
+cloudposse/github-action-pull-request-labeling
+cloudposse/github-action-interface-environment
+cloudposse/github-action-docker-compose-test-run
+cloudposse/github-action-telemetry
+cloudposse/github-action-sync-docker-repos
+cloudposse/github-action-pre-commit
+cloudposse/github-action-seek-deployment
+cloudposse/github-action-config-levels
+cloudposse/github-action-major-release-tagger
+cloudposse/github-action-release-branch-manager
+cloudposse/github-action-matrix-extended
+cloudposse/github-action-spacelift-stack-deploy
+cloudposse/github-action-docker-promote
+cloudposse/github-action-release-label-validator
+cloudposse/github-action-monorepo-random-controller
diff --git a/migrate/migrations/20250915/repos-01 b/migrate/migrations/20250915/repos-01
@@ -0,0 +1,16 @@
+cloudposse/github-action-secret-outputs
+cloudposse/github-action-aws-region-reduction-map
+cloudposse/github-action-docker-build-push
+cloudposse/github-action-atmos-terraform-select-components
+cloudposse/github-action-matrix-outputs-read
+cloudposse/github-action-atmos-component-updater
+cloudposse/github-action-preview-labels-cleanup
+cloudposse/github-action-terratest
+cloudposse/github-action-auto-format
+cloudposse/github-action-kubernetes-environment
+cloudposse/github-action-terraform-auto-context
+cloudposse/github-action-jq
+cloudposse/github-action-atmos-terraform-plan
+cloudposse/github-action-atmos-terraform-drift-detection
+cloudposse/github-action-setup-atmos
+cloudposse/github-action-atmos-affected-trigger-spacelift
diff --git a/migrate/migrations/20250915/repos-02 b/migrate/migrations/20250915/repos-02
@@ -0,0 +1,16 @@
+cloudposse/github-action-wait-commit-status
+cloudposse/github-action-docker-image-exists
+cloudposse/github-action-preview-environment-controller
+cloudposse/github-action-run-ecspresso
+cloudposse/github-action-matrix-outputs-write
+cloudposse/github-action-deploy-spacelift
+cloudposse/github-action-deploy-ecspresso
+cloudposse/github-action-deploy-helmfile
+cloudposse/github-action-yaml-config-query
+cloudposse/github-action-atmos-affected-stacks
+cloudposse/github-action-atmos-terraform-apply
+cloudposse/github-action-atmos-get-setting
+cloudposse/github-action-validate-codeowners
+cloudposse/github-action-atmos-terraform-drift-remediation
+cloudposse/github-action-auto-release
+cloudposse/github-action-deploy-argocd
diff --git a/migrate/migrations/20250915/repos-03 b/migrate/migrations/20250915/repos-03
@@ -0,0 +1 @@
+cloudposse/github-action-terraform-plan-storage
diff --git a/migrate/migrations/20250915/repos.sh b/migrate/migrations/20250915/repos.sh
@@ -0,0 +1,5 @@
+#!/bin/bash
+gh repo list cloudposse --limit 500 --json name,owner \
+	--jq '.[] | select(.name | test("^github-action-")) | select(.name | test("github-action-atmos-dependencies-test") | not) | .owner.login + "/" + .name' > repos.txt
+
+split -d -l 16 repos.txt repos-
diff --git a/migrate/migrations/20250915/repos.txt b/migrate/migrations/20250915/repos.txt
@@ -0,0 +1,49 @@
+cloudposse/github-action-datadog-notify
+cloudposse/github-action-pull-request-labeling
+cloudposse/github-action-interface-environment
+cloudposse/github-action-docker-compose-test-run
+cloudposse/github-action-telemetry
+cloudposse/github-action-sync-docker-repos
+cloudposse/github-action-pre-commit
+cloudposse/github-action-seek-deployment
+cloudposse/github-action-config-levels
+cloudposse/github-action-major-release-tagger
+cloudposse/github-action-release-branch-manager
+cloudposse/github-action-matrix-extended
+cloudposse/github-action-spacelift-stack-deploy
+cloudposse/github-action-docker-promote
+cloudposse/github-action-release-label-validator
+cloudposse/github-action-monorepo-random-controller
+cloudposse/github-action-secret-outputs
+cloudposse/github-action-aws-region-reduction-map
+cloudposse/github-action-docker-build-push
+cloudposse/github-action-atmos-terraform-select-components
+cloudposse/github-action-matrix-outputs-read
+cloudposse/github-action-atmos-component-updater
+cloudposse/github-action-preview-labels-cleanup
+cloudposse/github-action-terratest
+cloudposse/github-action-auto-format
+cloudposse/github-action-kubernetes-environment
+cloudposse/github-action-terraform-auto-context
+cloudposse/github-action-jq
+cloudposse/github-action-atmos-terraform-plan
+cloudposse/github-action-atmos-terraform-drift-detection
+cloudposse/github-action-setup-atmos
+cloudposse/github-action-atmos-affected-trigger-spacelift
+cloudposse/github-action-wait-commit-status
+cloudposse/github-action-docker-image-exists
+cloudposse/github-action-preview-environment-controller
+cloudposse/github-action-run-ecspresso
+cloudposse/github-action-matrix-outputs-write
+cloudposse/github-action-deploy-spacelift
+cloudposse/github-action-deploy-ecspresso
+cloudposse/github-action-deploy-helmfile
+cloudposse/github-action-yaml-config-query
+cloudposse/github-action-atmos-affected-stacks
+cloudposse/github-action-atmos-terraform-apply
+cloudposse/github-action-atmos-get-setting
+cloudposse/github-action-validate-codeowners
+cloudposse/github-action-atmos-terraform-drift-remediation
+cloudposse/github-action-auto-release
+cloudposse/github-action-deploy-argocd
+cloudposse/github-action-terraform-plan-storage
diff --git a/migrate/migrations/20250915/script.sh b/migrate/migrations/20250915/script.sh
@@ -0,0 +1,84 @@
+title "Replace Makefile with atmos.yaml"
+
+remove Makefile
+remove docs/github-action.md
+remove docs/targets.md
+install atmos.yaml
+
+# Iterate over workflow test files and add workflow_dispatch inputs
+for workflow_file in .github/workflows/test*.yml .github/workflows/test*.yaml; do
+    if [ -f "$workflow_file" ]; then
+        # Remove empty workflow_dispatch: {} if it exists
+        sed -i '' 's/workflow_dispatch: *{}/workflow_dispatch:/' "$workflow_file"
+        # Check if workflow_dispatch already exists in the 'on' section
+        if grep -q "workflow_dispatch:" "$workflow_file"; then
+            # Add inputs section if it doesn't exist
+            if ! grep -A 20 "workflow_dispatch:" "$workflow_file" | grep -q "inputs:"; then
+                sed -i '' '/workflow_dispatch:/a\
+    inputs:\
+      ref:\
+        description: "The fully-formed ref of the branch or tag that triggered the workflow run"\
+        required: false\
+        type: "string"\
+      sha:\
+        description: "The sha of the commit that triggered the workflow run"\
+        required: false\
+        type: "string"' "$workflow_file"
+            fi
+        else
+            # Add workflow_dispatch section after the 'on:' line
+            sed -i '' '/^on:/a\
+  workflow_dispatch:\
+    inputs:\
+      ref:\
+        description: "The fully-formed ref of the branch or tag that triggered the workflow run"\
+        required: false\
+        type: "string"\
+      sha:\
+        description: "The sha of the commit that triggered the workflow run"\
+        required: false\
+        type: "string"' "$workflow_file"
+        fi
+        
+        # Add the ref and sha inputs if they don't already exist (when inputs: already exists)
+        if grep -A 20 "workflow_dispatch:" "$workflow_file" | grep -q "inputs:" && ! grep -A 50 "workflow_dispatch:" "$workflow_file" | grep -q "ref:"; then
+            sed -i '' '/inputs:/a\
+      ref:\
+        description: "The fully-formed ref of the branch or tag that triggered the workflow run"\
+        required: false\
+        type: "string"' "$workflow_file"
+        fi
+        
+        if grep -A 20 "workflow_dispatch:" "$workflow_file" | grep -q "inputs:" && ! grep -A 50 "workflow_dispatch:" "$workflow_file" | grep -q "sha:"; then
+            sed -i '' '/inputs:/a\
+      sha:\
+        description: "The sha of the commit that triggered the workflow run"\
+        required: false\
+        type: "string"' "$workflow_file"
+        fi
+    fi
+done
+
+# Remove includes from README.yaml if they contain docs/github-actions.md and/or docs/targets.md
+if [ -f "README.yaml" ]; then
+    # Create a temporary file to store the modified content
+    temp_file=$(mktemp)
+    
+    # Use grep to remove lines containing the specific docs files from includes
+    grep -v -E "docs/(github-action|target)\.md" README.yaml > "$temp_file"
+    
+    # Check if the includes section would be empty after removals
+    if grep -q "^include:" "$temp_file"; then
+        # Check if there are any remaining include items (lines starting with - after include:)
+        if ! awk '/^include:/{flag=1; next} flag && /^[^ ]/{exit} flag && /^\s*-/{found=1; exit} END{exit !found}' "$temp_file"; then
+            # Set includes to empty array if no items remain
+            sed -i '' 's/^include:.*/include: []/' "$temp_file"
+        fi
+    fi
+    # Replace the original file with the modified content
+    mv "$temp_file" README.yaml
+    
+    echo "Processed README.yaml to remove docs/github-actions.md and docs/targets.md from includes"
+fi
+# Merge the PR
+auto_merge

Original file line number	Diff line number	Diff line change
`@@ -5,3 +5,4 @@`
`5`	`5`
`6`	`6`	`.build-harness`
`7`	`7`	`build-harness`
	`8`	`+.atmos`