Skip to content

[plan] Improve Error Experience Engineering across gh-aw #9236

@github-actions

Description

@github-actions

Overview

This tracking issue covers systematic improvements to error handling, formatting, and developer experience across the gh-aw codebase.

Source: Discussion #9231

Context

Current analysis reveals significant gaps in error experience:

  • Only 3% (44/1,450) of errors use console formatting despite AGENTS.md requirements
  • 178 raw error outputs lacking proper formatting
  • 80 plain errors.New() calls losing context
  • Only 11 debug logs for error paths
  • 0 panic recovery mechanisms

These issues create inconsistent user experience and hinder debugging capabilities.

Planned Sub-Issues

This work is broken into 5 focused tasks:

  1. Console Format CLI Error Messages - Convert raw error outputs to use console.FormatErrorMessage() for consistent presentation
  2. Add Error Context Wrapping - Replace plain errors.New() with fmt.Errorf using %w to preserve error chains
  3. Implement Debug Logging - Add structured debug logging to critical error paths for better troubleshooting
  4. Create Error Recovery Documentation - Document error patterns, recovery strategies, and debugging techniques
  5. Add Panic Recovery Mechanisms - Implement panic recovery for critical operations to prevent crashes

Success Metrics

  • Console formatting coverage: 3% → 100%
  • Error context preservation: 55.8% → 95%
  • Debug logging: 11 → 50+ instances
  • Panic recovery: 0 → 4+ critical entry points
  • Documentation: 1 → 4 comprehensive docs

Priority

High Priority - Errors are the primary interface during workflow development. Improving error experience directly impacts time to resolution, learning curve, and user confidence.

AI generated by Plan Command for discussion #9231

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions