atmos icon indicating copy to clipboard operation
atmos copied to clipboard

Remove deprecated --verbose flag from describe affected command

Open coderabbitai[bot] opened this issue 5 months ago • 1 comments

Summary

The --verbose flag has been deprecated in the atmos describe affected command in favor of the --logs-level flag.

Background

As part of PR #1327, the --verbose flag was deprecated with a warning message directing users to use --logs-level=Debug instead.

Tasks

  • [ ] Remove the deprecated --verbose flag from cmd/describe_affected.go
  • [ ] Remove related verbose handling code
  • [ ] Update any documentation that references the old flag
  • [ ] Ensure all tests pass after removal

References

  • PR: https://github.com/cloudposse/atmos/pull/1327
  • Comment: https://github.com/cloudposse/atmos/pull/1327#discussion_r2162523848

/cc @osterman

coderabbitai[bot] avatar Jun 23 '25 21:06 coderabbitai[bot]

Also relates to #1296

osterman avatar Jun 26 '25 19:06 osterman

Verbose Flag Clarification

The --verbose flag mentioned in this issue for the describe affected command was specifically about logging verbosity - showing verbose log output during command execution. That specific usage was deprecated in favor of using --logs-level=Debug for controlling logging verbosity.

However, the global --verbose flag still exists and serves a different purpose: it controls ERROR verbosity, not logging verbosity.

Two Separate Concerns

--verbose (Error Verbosity):

  • Shows detailed error messages with context tables and stack traces
  • Displays structured context (component, stack, region, etc.) as formatted tables
  • Helps with debugging by showing the full error chain
  • Controlled by: --verbose flag, ATMOS_VERBOSE env var, or errors.format.verbose: true in config

--logs-level=Debug (Logging Verbosity):

  • Shows verbose log output during command execution
  • Controls the logging level (Error, Warn, Info, Debug, Trace)
  • Helps with understanding what the command is doing internally
  • Controlled by: --logs-level flag or ATMOS_LOGS_LEVEL env var

Resolution

PR #1599 implements comprehensive error handling with the --verbose flag for error verbosity:

  • Context tables display structured error context in verbose mode
  • Markdown rendering with proper 4-space indentation
  • 14+ error scenarios now have context-aware hints
  • Full documentation in website/docs/cli/global-flags.mdx

This issue is resolved by PR #1599. The --verbose flag continues to exist for error verbosity, which is a distinct concern from the deprecated logging verbosity for describe affected.

Closing this issue as resolved.

osterman avatar Oct 06 '25 16:10 osterman