Merge branch 'main' into feature/dev-3131-add-pager-to-atmos-describe-config-command

Author: samtholiya

.github/workflows/test.yml

@@ -19,6 +19,7 @@ on:
 
 env:
   TERRAFORM_VERSION: "1.9.7"
+  OPEN_TOFU_VERSION: "1.9.1"
 
 jobs:
   # ensure the code builds...
@@ -115,11 +116,18 @@ jobs:
           }
           echo "${{ github.workspace }}" >> $Env:GITHUB_PATH
 
-      - uses: hashicorp/setup-terraform@v3
+      - name: Install Terraform
+        uses: hashicorp/setup-terraform@v3
         with:
           terraform_version: ${{ env.TERRAFORM_VERSION }}
           terraform_wrapper: false
 
+      - name: Install OpenTofu
+        uses: opentofu/setup-opentofu@v1
+        with:
+          tofu_version: ${{ env.OPEN_TOFU_VERSION }}
+          tofu_wrapper: false
+
       - name: Check atmos.exe integrity
         if: matrix.flavor.target == 'windows'
         shell: pwsh
@@ -242,11 +250,18 @@ jobs:
       - name: Check out code into the Go module directory
         uses: actions/checkout@v4
 
-      - uses: hashicorp/setup-terraform@v3
+      - name: Install Terraform
+        uses: hashicorp/setup-terraform@v3
         with:
           terraform_version: ${{ env.TERRAFORM_VERSION }}
           terraform_wrapper: false
 
+      - name: Install OpenTofu
+        uses: opentofu/setup-opentofu@v1
+        with:
+          tofu_version: ${{ env.OPEN_TOFU_VERSION }}
+          tofu_wrapper: false
+
       - name: Run tests for ${{ matrix.demo-folder }}
         run: |
           cd examples/${{ matrix.demo-folder }}
@@ -370,11 +385,18 @@ jobs:
         run: |
           echo "${{ github.workspace }}" >> $Env:GITHUB_PATH
 
-      - uses: hashicorp/setup-terraform@v3
+      - name: Install Terraform
+        uses: hashicorp/setup-terraform@v3
         with:
           terraform_version: ${{ env.TERRAFORM_VERSION }}
           terraform_wrapper: false
 
+      - name: Install OpenTofu
+        uses: opentofu/setup-opentofu@v1
+        with:
+          tofu_version: ${{ env.OPEN_TOFU_VERSION }}
+          tofu_wrapper: false
+
       - name: Run tests in ${{ matrix.demo-folder }} for ${{ matrix.flavor.target }}
         working-directory: ${{ matrix.demo-folder }}
         if: matrix.flavor.target == 'linux' || matrix.flavor.target == 'macos'
@@ -442,6 +464,12 @@ jobs:
           terraform_version: ${{ env.TERRAFORM_VERSION }}
           terraform_wrapper: false
 
+      - name: Install OpenTofu
+        uses: opentofu/setup-opentofu@v1
+        with:
+          tofu_version: ${{ env.OPEN_TOFU_VERSION }}
+          tofu_wrapper: false
+
       - name: Lint examples/${{ matrix.demo-folder }}/components/terraform
         uses: reviewdog/action-tflint@v1
         with:

atmos.yaml

@@ -383,6 +383,28 @@ settings:
       color: "${colors.muted}"
       italic: true
 
+docs:
+  generate:
+    # Generate README in current working directory
+    readme:
+      base-dir: .
+      input:
+        - "./README.yaml"
+      # To Do: template can be a remote URL/github, using this local for testing
+      template:  "https://raw.githubusercontent.com/cloudposse/.github/5a599e3b929f871f333cb9681a721d26b237d8de/README.md.gotmpl"
+      # The final README
+      output: "./README.md"
+      terraform:
+        source: src/
+        enabled: false
+        format: "markdown"
+        show_providers: false
+        show_inputs: true
+        show_outputs: true
+        sort_by: "name"
+        hide_empty: false
+        indent_level: 2   
+
 version:
   check:
     enabled: true

cmd/docs_generate.go

@@ -0,0 +1,33 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+
+	e "github.com/cloudposse/atmos/internal/exec"
+)
+
+// docsGenerateCmd is the subcommand under docs that groups generation operations.
+var docsGenerateCmd = &cobra.Command{
+	Use:   "generate",
+	Short: "Generate documentation artifacts",
+	Long: `Generate documentation by merging YAML data sources and applying templates.
+Supports native terraform-docs injection.`,
+	Example: `Generate the README.md in the current directory:
+  atmos docs generate readme`,
+	Args:      cobra.ExactArgs(1),
+	ValidArgs: []string{"readme"},
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return ErrInvalidArguments
+		}
+		err := e.ExecuteDocsGenerateCmd(cmd, args)
+		if err != nil {
+			return err
+		}
+		return nil
+	},
+}
+
+func init() {
+	docsCmd.AddCommand(docsGenerateCmd)
+}

examples/quick-start-advanced/Dockerfile

@@ -6,7 +6,7 @@ ARG GEODESIC_OS=debian
 # https://atmos.tools/
 # https://github.com/cloudposse/atmos
 # https://github.com/cloudposse/atmos/releases
-ARG ATMOS_VERSION=1.173.0
+ARG ATMOS_VERSION=1.175.0
 
 # Terraform: https://github.com/hashicorp/terraform/releases
 ARG TF_VERSION=1.5.7