[architecture] Update architecture diagram - 2026-04-24#28227
Merged
Conversation
Full rebuild from scratch — 22 packages analyzed across cmd/ and pkg/. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
/q run weekly on Mondays |
Contributor
Author
|
🎩 Mission equipment ready! Q has optimized your workflow. Use wisely, 007! 🔫 |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the repository architecture documentation by rebuilding the ASCII architecture diagram and package reference to reflect current cmd/ and pkg/ structure/dependencies.
Changes:
- Added a rebuilt 3-layer ASCII architecture diagram (Entry Points → Core Packages → Utility Packages) with dependency arrows.
- Added/updated a Package Reference table enumerating packages and their roles.
- Updated “Last updated” metadata and added a “Source” link for traceability.
Show a summary per file
| File | Description |
|---|---|
scratchpad/architecture.md |
Replaces/extends the architecture documentation with a newly generated diagram and package reference (currently duplicated with the previous version). |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 4
| @@ -1,5 +1,84 @@ | |||
| # Architecture Diagram | |||
|
|
|||
| > Last updated: 2026-04-24 · Source: [🏗️ Architecture Diagram: gh-aw Repository Architecture Diagram (2026-04-24)](https://github.com/github/gh-aw/issues) | |||
Comment on lines
+57
to
+73
| | Package | Layer | Description | | ||
| |---------|-------|-------------| | ||
| | `cli` | Core | Command implementations (compile, run, mcp, logs, audit) | | ||
| | `workflow` | Core | Workflow compilation engine (markdown → GitHub Actions YAML) | | ||
| | `parser` | Core | Markdown/YAML frontmatter parsing and content extraction | | ||
| | `console` | Core | Terminal UI rendering and formatting utilities | | ||
| | `actionpins` | Core | Action pin resolution and semver-aware pinning | | ||
| | `agentdrain` | Core | Agent output stream drain and handling | | ||
| | `logger` | Utility | Namespace-based debug logging with zero overhead | | ||
| | `styles` | Utility | Centralized terminal style and color definitions | | ||
| | `tty` | Utility | TTY (terminal) detection utilities | | ||
| | `fileutil` | Utility | File path and file operation utilities | | ||
| | `gitutil` | Utility | Git repository utilities | | ||
| | `types` | Utility | Shared type definitions used across packages | | ||
| | `constants` | Utility | Shared constants and semantic type aliases | | ||
| | `stringutil` | Utility | String manipulation utilities (including ANSI stripping) | | ||
| | `sliceutil` | Utility | Generic slice utilities | |
Comment on lines
+80
to
84
| | `testutil` | Utility | Test helper utilities | | ||
|
|
||
| > Last updated: 2026-04-23 · Source: Issue #28016 (Architecture Diagram) | ||
|
|
||
| ## Overview |
| │ ENTRY POINTS │ | ||
| │ ┌──────────────────────────┐ ┌───────────────────────────────┐ │ | ||
| │ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │ | ||
| │ │ main CLI binary │ │ WebAssembly compilation target│ │ |
Closed
Contributor
Author
Contributor
Author
|
Note The pull request was not created — a fallback review issue was created instead due to protected file changes: #28284 🎩 Mission accepted, 007! I've created a PR to add a weekly Monday schedule to the Q workflow. The Q workflow will now run automatically every Monday at 9am UTC (
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates
scratchpad/architecture.mdwith a full-rebuild ASCII architecture diagram showing all 22 packages acrosscmd/andpkg/.What changed
Diagram highlights
cmd/gh-awandcmd/gh-aw-wasmat the topcli,workflow,parser,console,actionpins,agentdrain