chore: Replace Makefile with atmos.yaml (#105)

Author: osterman

Makefile

@@ -1,4 +1,3 @@
----
 #
 # This is the canonical configuration for the `README.md`
 # Run `make readme` to rebuild the `README.md`
@@ -17,13 +16,17 @@ license: "APACHE2"
 github_repo: cloudposse/github-action-atmos-terraform-plan
 
 badges:
-  - name: "Latest Release"
-    image: "https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg"
-    url: "https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest"
-  - name: "Slack Community"
-    image: "https://slack.cloudposse.com/badge.svg"
-    url: "https://slack.cloudposse.com"
-
+  - name: Latest Release
+    image: https://img.shields.io/github/release/cloudposse/github-action-atmos-terraform-plan.svg?style=for-the-badge
+    url: https://github.com/cloudposse/github-action-atmos-terraform-plan/releases/latest
+  - name: Last Updated
+    image: https://img.shields.io/github/last-commit/cloudposse/github-action-atmos-terraform-plan.svg?style=for-the-badge
+    url: https://github.com/cloudposse/github-action-atmos-terraform-plan/commits
+  - name: Slack Community
+    image: https://slack.cloudposse.com/for-the-badge.svg
+    url: https://cloudposse.com/slack
+
+# List any related terraform modules that this module may be used with or that this module depends on.
 related: []
 
 description: This Github Action is used to run Terraform plan for a single, Atmos-supported component and save the given planfile to S3 and DynamoDB.
@@ -62,15 +65,15 @@ usage: |-
   > If you are using `atmos < 1.63.0` please use `v1` version of this action.
 
   The action expects the atmos configuration file `atmos.yaml` to be present in the repository.
-  
+
   The action supports AWS and Azure to store Terraform plan files. 
   You can read more about plan storage in the [cloudposse/github-action-terraform-plan-storage](https://github.com/cloudposse/github-action-terraform-plan-storage?tab=readme-ov-file#aws-default) documentation. 
   Depending on the cloud provider, the following fields should be set in the `atmos.yaml`:
-  
+
   #### AWS
-  
+
   The config should have the following structure:
-  
+
   ```yaml
   integrations:
     github:
@@ -95,9 +98,9 @@ usage: |-
   ```
 
   #### Azure
-  
+
   The config should have the following structure:
-  
+
   ```yaml
   integrations:
     github:
@@ -144,29 +147,29 @@ usage: |-
                   plan: arn:aws:iam::yyyyyyyyyyyy:role/cptest-plat-gbl-identity-gitops
                   apply: arn:aws:iam::yyyyyyyyyyyy:role/cptest-plat-gbl-identity-gitops
   ```  
-  
+
   ### Support OpenTofu
-  
+
   This action supports [OpenTofu](https://opentofu.org/).
-  
+
   > [!IMPORTANT]
   > **Please note!** OpenTofu supported by Atmos `>= 1.73.0`.
   > For details [read](https://atmos.tools/core-concepts/projects/configuration/opentofu/)
-  
+
   To enable OpenTofu add the following settings to `atmos.yaml`
     * Set the `opentofu-version` in the `atmos.yaml` to the desired version
     * Set `components.terraform.command` to `tofu`
-  
+
   #### Example
-  
+
   ```yaml
-  
+
   components:
     terraform:
       command: tofu
- 
+
   ...
-  
+
   integrations:
     github:
       gitops:
@@ -208,13 +211,13 @@ usage: |-
   ```
 
   ### Migrating from `v4` to `v5`
-  
+
   The notable changes in `v5` are:
   - `v5` works only with `atmos >= 1.158.0`
   - `v5` supports atnos `templates` and `functions`
-  
+
   ### Migrating from `v3` to `v4`
-  
+
   The notable changes in `v4` are:
 
   - `v4` works only with `atmos >= 1.99.0`
@@ -226,7 +229,7 @@ usage: |-
   The only required migration step is updating atmos version to `>= 1.99.0` 
 
   ### Migrating from `v2` to `v3`
-  
+
   The notable changes in `v3` are:
 
   - `v3` use `actions/upload-artifact@v4` to share artifacts so it is not compatible with `cloudposse/github-action-atmos-terraform-drift-detection` `< v2.0.0`
@@ -236,23 +239,23 @@ usage: |-
   No special migration steps required
 
   ### Migrating from `v1` to `v2`
-  
+
   The notable changes in `v2` are:
 
   - `v2` works only with `atmos >= 1.63.0`
   - `v2` drops `install-terraform` input because terraform is not required for affected stacks call
   - `v2` drops `atmos-gitops-config-path` input and the `./.github/config/atmos-gitops.yaml` config file. Now you have to use GitHub Actions environment variables to specify the location of the `atmos.yaml`.
-  
+
   The following configuration fields now moved to GitHub action inputs with the same names
-  
+
   |         name            |
   |-------------------------|
   | `atmos-version`         |
   | `atmos-config-path`     |
-  
-  
+
+
   The following configuration fields moved to the `atmos.yaml` configuration file. 
-  
+
   |              name        |   YAML path in `atmos.yaml`                     |
   |--------------------------|-------------------------------------------------|
   | `aws-region`             | `integrations.github.gitops.artifact-storage.region`     | 
@@ -265,14 +268,14 @@ usage: |-
   | `enable-infracost`       |  `integrations.github.gitops.infracost-enabled` |
   | `sort-by`                |  `integrations.github.gitops.matrix.sort-by`    |
   | `group-by`               |  `integrations.github.gitops.matrix.group-by`   |
-  
-  
+
+
   For example, to migrate from `v1` to `v2`, you should have something similar to the following in your `atmos.yaml`: 
-  
+
   `./.github/config/atmos.yaml`
   ```yaml
   # ... your existing configuration
-  
+
   integrations:
     github:
       gitops:
@@ -290,7 +293,7 @@ usage: |-
           sort-by: .stack_slug
           group-by: .stack_slug | split("-") | [.[0], .[2]] | join("-")
   ```
-  
+
   `.github/workflows/main.yaml`
   ```yaml
     - name: Plan Atmos Component
@@ -301,9 +304,9 @@ usage: |-
         atmos-config-path: ./rootfs/usr/local/etc/atmos/
         atmos-version: 1.63.0
   ``` 
-  
+
   This corresponds to the `v1` configuration (deprecated) below.
-  
+
   The `v1` configuration file `./.github/config/atmos-gitops.yaml` looked like this:
   ```yaml
   atmos-version: 1.45.3
@@ -319,9 +322,9 @@ usage: |-
   sort-by: .stack_slug
   group-by: .stack_slug | split("-") | [.[0], .[2]] | join("-")  
   ```
-  
+
   And the `v1` GitHub Action Workflow looked like this.
-  
+
   `.github/workflows/main.yaml`
   ```yaml
     - name: Plan Atmos Component
@@ -333,7 +336,7 @@ usage: |-
   ```
     
   ### Migrating from `v1` to `v2`
-  
+
   1.  `v2` drops the `component-path` variable and instead fetches if directly from the [`atmos.yaml` file](https://atmos.tools/cli/configuration/) automatically. Simply remove the `component-path` argument from your invocations of the `cloudposse/github-action-atmos-terraform-plan` action.
   2.  `v2` moves most of the `inputs` to the Atmos GitOps config path `./.github/config/atmos-gitops.yaml`. Simply create this file, transfer your settings to it, then remove the corresponding arguments from your invocations of the `cloudposse/github-action-atmos-terraform-plan` action.
   |         name             |
@@ -348,10 +351,10 @@ usage: |-
   | `terraform-version`      |
   | `aws-region`             |
   | `enable-infracost`       |
-  
-  
+
+
   If you want the same behavior in `v2` as in `v1` you should create config `./.github/config/atmos-gitops.yaml` with the same variables as in `v1` inputs.
-  
+
   ```yaml
     - name: Plan Atmos Component
       uses: cloudposse/github-action-atmos-terraform-plan@v1
@@ -360,9 +363,9 @@ usage: |-
         stack: "plat-ue2-sandbox"
         atmos-gitops-config-path: ./.github/config/atmos-gitops.yaml
   ```
-  
+
   Which would produce the same behavior as in `v1`, doing this:
-  
+
   ```yaml
     - name: Plan Atmos Component
       uses: cloudposse/github-action-atmos-terraform-plan@v1
@@ -376,14 +379,7 @@ usage: |-
         terraform-state-table: "acme-core-ue2-auto-gitops"
         aws-region: "us-east-2"
   ```
-  
 
-include:
-  - "docs/github-action.md"
 
-# Contributors to this project
-contributors:
-  - name: "Erik Osterman"
-    github: "osterman"
-  - name: "Daniel Miller"
-    github: "milldr"
+include: []
+contributors: []

README.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/terraform-module.yaml