Skip to content

docs: add Debugging & Logging section to AGENTS.md - #48823

Merged
pelikhan merged 1 commit into
mainfrom
copilot/update-agents-md-logging-configuration
Jul 29, 2026
Merged

docs: add Debugging & Logging section to AGENTS.md#48823
pelikhan merged 1 commit into
mainfrom
copilot/update-agents-md-logging-configuration

Conversation

Copilot AI commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Agents had no documented path to enable targeted debug output from gh aw CLI runs, making it hard to diagnose issues without modifying source code.

Changes

  • AGENTS.md — new "Debugging & Logging" section covering:
    • DEBUG=<pattern> and DEBUG_COLORS env vars with copy-paste examples
    • Namespace reference table (cli:*, workflow:*, parser:*, mcp:*, agentdrain:*, …)
    • How to discover a namespace (logger.New(...) at top of each .go file)
    • ACTIONS_RUNNER_DEBUG=true auto-activation in GitHub Actions debug runs
    • Output format: namespace message +elapsed
# Target a specific subsystem
DEBUG=cli:run_workflow_execution,cli:retry gh aw run workflow.md

# Capture full trace to file
DEBUG_COLORS=0 DEBUG=* gh aw compile workflow.md 2>debug.log

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI requested a review from pelikhan July 29, 2026 08:29
@pelikhan
pelikhan marked this pull request as ready for review July 29, 2026 08:33
Copilot AI review requested due to automatic review settings July 29, 2026 08:33
@pelikhan
pelikhan merged commit 0c8156c into main Jul 29, 2026
@pelikhan
pelikhan deleted the copilot/update-agents-md-logging-configuration branch July 29, 2026 08:33

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds targeted debugging and logging guidance for gh aw CLI runs.

Changes:

  • Documents debug environment variables and namespace filters.
  • Explains GitHub Actions debug behavior and log output format.
Show a summary per file
File Description
AGENTS.md Adds debugging and logging instructions for agents.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Medium

Comment thread AGENTS.md

### GitHub Actions debug runs

When `ACTIONS_RUNNER_DEBUG=true` is set (enabled automatically on re-run with debug logging in the GitHub UI), all loggers are activated — equivalent to `DEBUG=*`. No extra configuration is needed.
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.83.5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants