Skip to content

[architecture] Update architecture diagram - 2026-04-26#28564

Merged
pelikhan merged 1 commit intomainfrom
architecture/update-diagram-2026-04-26-afd2f5099ef7ff02
Apr 26, 2026
Merged

[architecture] Update architecture diagram - 2026-04-26#28564
pelikhan merged 1 commit intomainfrom
architecture/update-diagram-2026-04-26-afd2f5099ef7ff02

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Updates scratchpad/architecture.md with a fresh full-rebuild of the architecture diagram.

What changed

  • Full rebuild from scratch (no prior cache)
  • Diagrams all 21 packages across cmd/ and pkg/
  • Accurately reflects dependency arrows between layers
  • Added agentdrain, stats, actionpins as distinct core packages

Diagram layers

  1. Entry points: cmd/gh-aw, cmd/gh-aw-wasm
  2. Core packages: cli, workflow, parser, console, actionpins, agentdrain, stats
  3. Utility packages: constants, envutil, fileutil, gitutil, logger, repoutil, semverutil, sliceutil, stringutil, styles, testutil, timeutil, tty, types, typeutil

Generated by Architecture Diagram Generator · ● 918.4K ·

  • expires on May 3, 2026, 9:06 AM UTC

Full rebuild of architecture diagram showing all 21 packages across cmd/ and pkg/.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added architecture diagram documentation Improvements or additions to documentation labels Apr 26, 2026
@pelikhan pelikhan marked this pull request as ready for review April 26, 2026 10:08
Copilot AI review requested due to automatic review settings April 26, 2026 10:08
@pelikhan pelikhan merged commit b0fe7e4 into main Apr 26, 2026
3 checks passed
@pelikhan pelikhan deleted the architecture/update-diagram-2026-04-26-afd2f5099ef7ff02 branch April 26, 2026 10:08
@github-actions github-actions Bot mentioned this pull request Apr 26, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Refreshes scratchpad/architecture.md with a newly generated ASCII architecture diagram and updated package reference for the gh-aw codebase.

Changes:

  • Rebuilt the ASCII architecture diagram layout (entry points, core packages, utility packages) and updated dependency annotations.
  • Updated the package reference table to match the newly generated diagram content and package layering.
Show a summary per file
File Description
scratchpad/architecture.md Replaces the prior diagram content with a fresh rebuild and updates the “Last updated”/package reference sections.

Copilot's findings

Tip

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

Comments suppressed due to low confidence (1)

scratchpad/architecture.md:73

  • The agentdrain row description doesn’t match the package documentation. pkg/agentdrain/README.md describes it as the Drain log template mining algorithm for structured agent pipeline events and anomaly detection, rather than “agent output streaming and draining”. Please adjust this description to avoid misleading readers.
| agentdrain | Core | Agent output streaming and draining |
| stats | Core | Numerical statistics for metric collection |
  • Files reviewed: 1/1 changed files
  • Comments generated: 2

# Architecture Diagram

> Last updated: 2026-04-25 · Source: [Issue #28411](https://github.com/github/gh-aw/issues)
> Last updated: 2026-04-26 · Source: [Issue #🏗️ Architecture Diagram: gh-aw Package Architecture Diagram (2026-04-26)](https://github.com/github/gh-aw/issues)
Copy link

Copilot AI Apr 26, 2026

Choose a reason for hiding this comment

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

The “Source” link text/URL doesn’t follow the documented format and currently links to the repo issues list (missing an issue number). This makes the update non-traceable. Please change it to Source: [Issue #<number>](https://github.com/github/gh-aw/issues/<number>) per .github/workflows/daily-architecture-diagram.md:195.

Suggested change
> Last updated: 2026-04-26 · Source: [Issue #🏗️ Architecture Diagram: gh-aw Package Architecture Diagram (2026-04-26)](https://github.com/github/gh-aw/issues)
> Last updated: 2026-04-26 · Source: [Issue #<number>](https://github.com/github/gh-aw/issues/<number>)

Copilot uses AI. Check for mistakes.
Comment on lines +37 to +38
│ │ Action pin │ │ Agent output streaming │ │ struct-tag rendering, message types │ │
│ │ resolution │ │ and draining │ └──────────────────────────────────────────┘ │
Copy link

Copilot AI Apr 26, 2026

Choose a reason for hiding this comment

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

The agentdrain description in the diagram appears inaccurate. The package implements the Drain log template mining algorithm for analyzing agent pipeline events / anomaly detection (see pkg/agentdrain/README.md:3), not primarily “agent output streaming and draining”. Please update the one-line description here to match the package’s documented purpose.

This issue also appears on line 72 of the same file.

Suggested change
│ │ Action pin │ │ Agent output streaming │ │ struct-tag rendering, message types │ │
│ │ resolution │ │ and draining │ └──────────────────────────────────────────┘ │
│ │ Action pin │ │ Drain log template │ │ struct-tag rendering, message types │ │
│ │ resolution │ │ mining for anomalies │ └──────────────────────────────────────────┘ │

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

architecture diagram documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants