Merge branch 'feature/dev-3182-add-pager-to-atmos-describe-affected-command' of https://github.com/cloudposse/atmos into feature/dev-3182-add-pager-to-atmos-describe-affected-command

Author: samtholiya

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/describe_component.go

@@ -9,9 +9,7 @@ import (
 	u "github.com/cloudposse/atmos/pkg/utils"
 )
 
-var (
-	errInvalidFlag = errors.New("invalid arguments. The command requires one argument `component`")
-)
+var errInvalidFlag = errors.New("invalid arguments. The command requires one argument `component`")
 
 // describeComponentCmd describes configuration for components
 var describeComponentCmd = &cobra.Command{

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)
+}