-
-
Notifications
You must be signed in to change notification settings - Fork 106
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* colors default * added more case colors * reorder ui * default renderer * adding styles * general styles * workflow implementation msgs * workflow implementation msgs * workflow implementation msgs * markdown start point implementation for workflow * markdown implementation and styles improvements * parser md implementation * workflow file * markdown renderer * purple and cyan colors back * fixes renderer and markdown * fix pkg location * fixes headers * sync main * updates for making styles dynamic set * markdown styles docs * fixes markdown and styles * fix help subcommands * dynamic size * terminal width * fixed colors names * replace namecolor * fix docs markdown * Update website/docs/cli/configuration/markdown-styling.mdx Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> * Update website/docs/cli/configuration/markdown-styling.mdx Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> * explain color degradation * fix h1 headers * remove broken link * format workflow file * added safe style * error handling for edge cases * Update website/docs/cli/configuration/markdown-styling.mdx Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> * update docs * update terminal settings * import statement * unify settings * remove example * remove deprecated options atmos.yaml Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> * updates * update yaml and clean up * general clean up * update docs * remove syntax * clean up spaces --------- Co-authored-by: Erik Osterman (CEO @ Cloud Posse) <[email protected]> Co-authored-by: aknysh <[email protected]>
- Loading branch information
3 people
authored
Jan 4, 2025
1 parent
02ec47e
commit 52a3442
Showing
16 changed files
with
1,383 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| Examples: | ||
|
|
||
| – Use interactive UI | ||
|
|
||
| $ atmos workflow | ||
|
|
||
| – Execute a workflow | ||
|
|
||
| $ atmos workflow <workflow-name> --file <file> | ||
|
|
||
| – Execute with stack override | ||
|
|
||
| $ atmos workflow <workflow-name> --file <file> --stack <stack> | ||
|
|
||
| – Resume from specific step | ||
|
|
||
| $ atmos workflow <workflow-name> --file <file> --from-step <step> | ||
|
|
||
| For more information, refer to the **docs**: | ||
| https://atmos.tools/cli/commands/workflow/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,200 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| _ "embed" | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/cobra" | ||
|
|
||
| e "github.com/cloudposse/atmos/internal/exec" | ||
| termwriter "github.com/cloudposse/atmos/internal/tui/templates/term" | ||
| cfg "github.com/cloudposse/atmos/pkg/config" | ||
| "github.com/cloudposse/atmos/pkg/schema" | ||
| "github.com/cloudposse/atmos/pkg/ui/markdown" | ||
| u "github.com/cloudposse/atmos/pkg/utils" | ||
| ) | ||
|
|
||
| //go:embed markdown/workflow.md | ||
| var workflowMarkdown string | ||
|
|
||
| // ErrorMessage represents a structured error message | ||
| type ErrorMessage struct { | ||
| Title string | ||
| Details string | ||
| Suggestion string | ||
| } | ||
|
|
||
| // renderError renders an error message using the markdown renderer | ||
| func renderError(msg ErrorMessage) error { | ||
| atmosConfig, err := cfg.InitCliConfig(schema.ConfigAndStacksInfo{}, false) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to initialize atmos config: %w", err) | ||
| } | ||
|
|
||
| termWriter := termwriter.NewResponsiveWriter(os.Stdout) | ||
| screenWidth := termWriter.(*termwriter.TerminalWriter).GetWidth() | ||
|
|
||
| if atmosConfig.Settings.Docs.MaxWidth > 0 { | ||
| screenWidth = uint(min(atmosConfig.Settings.Docs.MaxWidth, int(screenWidth))) | ||
| } | ||
|
|
||
| renderer, err := markdown.NewRenderer( | ||
| markdown.WithWidth(screenWidth), | ||
| ) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create markdown renderer: %w", err) | ||
| } | ||
|
|
||
| rendered, err := renderer.RenderError(msg.Title, msg.Details, msg.Suggestion) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to render error message: %w", err) | ||
| } | ||
|
|
||
| fmt.Print(rendered) | ||
| return nil | ||
| } | ||
|
|
||
| // getMarkdownSection returns a section from the markdown file | ||
| func getMarkdownSection(title string) (details, suggestion string) { | ||
| sections := markdown.ParseMarkdownSections(workflowMarkdown) | ||
| if section, ok := sections[title]; ok { | ||
| parts := markdown.SplitMarkdownContent(section) | ||
| if len(parts) >= 2 { | ||
| return parts[0], parts[1] | ||
| } | ||
| return section, "" | ||
| } | ||
| return "", "" | ||
| } | ||
|
|
||
| // workflowCmd executes a workflow | ||
| var workflowCmd = &cobra.Command{ | ||
| Use: "workflow", | ||
| Short: "Execute a workflow", | ||
| Long: `This command executes a workflow: atmos workflow <name> -f <file>`, | ||
| Long: `This command executes a workflow: atmos workflow <name> --file <file>`, | ||
| Example: "atmos workflow\n" + | ||
| "atmos workflow <name> -f <file>\n" + | ||
| "atmos workflow <name> -f <file> -s <stack>\n" + | ||
| "atmos workflow <name> -f <file> --from-step <step-name>\n\n" + | ||
| "atmos workflow <name> --file <file>\n" + | ||
| "atmos workflow <name> --file <file> --stack <stack>\n" + | ||
| "atmos workflow <name> --file <file> --from-step <step-name>\n\n" + | ||
| "To resume the workflow from this step, run:\n" + | ||
| "atmos workflow deploy-infra -f workflow1 --from-step deploy-vpc\n\n" + | ||
| "atmos workflow deploy-infra --file workflow1 --from-step deploy-vpc\n\n" + | ||
| "For more details refer to https://atmos.tools/cli/commands/workflow/", | ||
| FParseErrWhitelist: struct{ UnknownFlags bool }{UnknownFlags: false}, | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| // If no arguments are provided, start the workflow UI | ||
| if len(args) == 0 { | ||
| err := e.ExecuteWorkflowCmd(cmd, args) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, err) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| if args[0] == "help" { | ||
| if err := cmd.Help(); err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, err) | ||
| } | ||
| return | ||
| } | ||
|
|
||
| // Get the --file flag value | ||
| workflowFile, _ := cmd.Flags().GetString("file") | ||
|
|
||
| // If no file is provided, show invalid command error with usage information | ||
| if workflowFile == "" { | ||
| // Get atmos configuration | ||
| atmosConfig, err := cfg.InitCliConfig(schema.ConfigAndStacksInfo{}, false) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, fmt.Errorf("failed to initialize atmos config: %w", err)) | ||
| } | ||
|
|
||
| // Create a terminal writer to get the optimal width | ||
| termWriter := termwriter.NewResponsiveWriter(os.Stdout) | ||
| screenWidth := termWriter.(*termwriter.TerminalWriter).GetWidth() | ||
|
|
||
| if atmosConfig.Settings.Docs.MaxWidth > 0 { | ||
| screenWidth = uint(min(atmosConfig.Settings.Docs.MaxWidth, int(screenWidth))) | ||
| } | ||
|
|
||
| renderer, err := markdown.NewRenderer( | ||
| markdown.WithWidth(screenWidth), | ||
| ) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, fmt.Errorf("failed to create markdown renderer: %w", err)) | ||
| } | ||
|
|
||
| // Generate the error message dynamically using H1 styling | ||
| errorMsg := fmt.Sprintf("# Invalid Command\n\nThe command `atmos workflow %s` is not valid.\n\n", args[0]) | ||
| content := errorMsg + workflowMarkdown | ||
| rendered, err := renderer.Render(content) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, fmt.Errorf("failed to render markdown: %w", err)) | ||
| } | ||
|
|
||
| // Remove duplicate URLs and format output | ||
| lines := strings.Split(rendered, "\n") | ||
| var result []string | ||
| seenURL := false | ||
|
|
||
| for _, line := range lines { | ||
| trimmed := strings.TrimSpace(line) | ||
| if strings.Contains(trimmed, "https://") { | ||
| if !seenURL { | ||
| seenURL = true | ||
| result = append(result, line) | ||
| } | ||
| } else if strings.HasPrefix(trimmed, "$") { | ||
| result = append(result, " "+strings.TrimSpace(line)) | ||
| } else if trimmed != "" { | ||
| result = append(result, line) | ||
| } | ||
| } | ||
|
|
||
| fmt.Print("\n" + strings.Join(result, "\n") + "\n\n") | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| // Execute the workflow command | ||
| err := e.ExecuteWorkflowCmd(cmd, args) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, err) | ||
| // Format common error messages | ||
| if strings.Contains(err.Error(), "does not exist") { | ||
| details, suggestion := getMarkdownSection("Workflow File Not Found") | ||
| err := renderError(ErrorMessage{ | ||
| Title: "Workflow File Not Found", | ||
| Details: details, | ||
| Suggestion: suggestion, | ||
| }) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, err) | ||
| } | ||
| } else if strings.Contains(err.Error(), "does not have the") { | ||
| details, suggestion := getMarkdownSection("Invalid Workflow") | ||
| err := renderError(ErrorMessage{ | ||
| Title: "Invalid Workflow", | ||
| Details: details, | ||
| Suggestion: suggestion, | ||
| }) | ||
| if err != nil { | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, err) | ||
| } | ||
| } else { | ||
| // For other errors, use the standard error handler | ||
| u.LogErrorAndExit(schema.AtmosConfiguration{}, err) | ||
| } | ||
| return | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| func init() { | ||
| workflowCmd.DisableFlagParsing = false | ||
| workflowCmd.PersistentFlags().StringP("file", "f", "", "atmos workflow <name> -f <file>") | ||
| workflowCmd.PersistentFlags().Bool("dry-run", false, "atmos workflow <name> -f <file> --dry-run") | ||
| workflowCmd.PersistentFlags().StringP("stack", "s", "", "atmos workflow <name> -f <file> -s <stack>") | ||
| workflowCmd.PersistentFlags().String("from-step", "", "atmos workflow <name> -f <file> --from-step <step-name>") | ||
| workflowCmd.PersistentFlags().StringP("file", "f", "", "atmos workflow <name> --file <file>") | ||
| workflowCmd.PersistentFlags().Bool("dry-run", false, "atmos workflow <name> --file <file> --dry-run") | ||
| workflowCmd.PersistentFlags().StringP("stack", "s", "", "atmos workflow <name> --file <file> --stack <stack>") | ||
| workflowCmd.PersistentFlags().String("from-step", "", "atmos workflow <name> --file <file> --from-step <step-name>") | ||
|
|
||
| RootCmd.AddCommand(workflowCmd) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.