Skip to content

[architecture] Update architecture diagram - 2026-04-27#28684

Merged
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-04-27-89c4df4733b29368
Apr 27, 2026
Merged

[architecture] Update architecture diagram - 2026-04-27#28684
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-04-27-89c4df4733b29368

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Full rebuild of the architecture diagram (cache miss — no prior state existed).

Changes

  • Refreshed scratchpad/architecture.md with updated diagram and package reference table
  • Corrected layer assignments: actionpins, agentdrain, stats moved to utility layer based on import count analysis
  • Added import frequency annotations to package reference table
  • Widened diagram to 102 chars to cleanly fit all package boxes

Analysis basis

  • Commit: 6dea27ee7256ea8d27e910e2b275e2b11ece4830
  • 22 packages analyzed across cmd/ and pkg/
  • Import relationships derived from grep across all non-test .go files

Generated by Architecture Diagram Generator · ● 757.2K ·

  • expires on May 4, 2026, 9:33 AM UTC

Full rebuild from cache miss. Refined layer assignments based on
actual import counts and dependency analysis.

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 27, 2026
@github-actions
Copy link
Copy Markdown
Contributor Author

Hey @github-actions — great work keeping the architecture diagram in sync with the latest codebase state! 🎉 The updated layer assignments and import frequency annotations for the 22 analyzed packages look like a solid, focused change.

One checklist item flagged automatically:

  • No test changes detected — for a pure documentation/diagram update in scratchpad/architecture.md, this is expected and not a blocker. No code logic was modified.

This PR looks ready for maintainer review. The diff is clean, scoped to a single file, and the description clearly explains the analysis basis and what changed.

No action needed — the architecture diagram PR is documentation-only and passes all substantive contribution checks.

Generated by Contribution Check · ● 1.1M ·

@pelikhan pelikhan marked this pull request as ready for review April 27, 2026 13:32
Copilot AI review requested due to automatic review settings April 27, 2026 13:32
@pelikhan pelikhan merged commit e2a8bf4 into main Apr 27, 2026
3 checks passed
@pelikhan pelikhan deleted the architecture-diagram-2026-04-27-89c4df4733b29368 branch April 27, 2026 13:32
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

Updates the repository’s gh-aw package architecture documentation with a rebuilt ASCII dependency diagram and an updated package reference table including import-frequency annotations.

Changes:

  • Rebuilt the ASCII architecture diagram (wider layout) and refreshed package layering (moving actionpins, agentdrain, stats to Utility).
  • Updated the package reference table to use cmd/... and pkg/... paths and added import-frequency annotations.
  • Updated the “Last updated” header metadata for the new run.
Show a summary per file
File Description
scratchpad/architecture.md Replaces the prior diagram/table with a rebuilt architecture diagram and import-frequency annotated package reference.

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: 3

| `pkg/parser` | Core | Markdown frontmatter parsing and YAML schema validation |
| `pkg/console` | Core | Terminal UI formatting (success/error/info/warning/progress) |
| `pkg/logger` | Utility | Namespace-based debug logging with zero overhead (531 imports) |
| `pkg/constants` | Utility | Shared typed constants: engines, versions, feature flags (221) |
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

Import-frequency annotations in the package table are inconsistent: pkg/constants has (221) while the surrounding rows use (N imports)/(1 import). Please standardize the annotation format (including pluralization) across all rows for easier scanning.

Suggested change
| `pkg/constants` | Utility | Shared typed constants: engines, versions, feature flags (221) |
| `pkg/constants` | Utility | Shared typed constants: engines, versions, feature flags (221 imports) |

Copilot uses AI. Check for mistakes.
# Architecture Diagram

> 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-27 · Source: [🏗️ Architecture Diagram: Full rebuild — gh-aw package architecture (2026-04-27)](https://github.com/github/gh-aw/issues)
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

The scratchpad header doesn’t follow the repo’s documented format for the architecture diagram source reference. The workflow instructions specify > Last updated: <YYYY-MM-DD> · Source: [Issue #<number>](<issue_url>) (.github/workflows/daily-architecture-diagram.md:195), but this links to the generic /issues page and omits the issue number/URL. Please update this to point to the specific generated issue (including its number).

Suggested change
> Last updated: 2026-04-27 · Source: [🏗️ Architecture Diagram: Full rebuild — gh-aw package architecture (2026-04-27)](https://github.com/github/gh-aw/issues)
> Last updated: 2026-04-27 · Source: [Issue #<number>](https://github.com/github/gh-aw/issues/<number>)

Copilot uses AI. Check for mistakes.
Comment on lines +13 to +20
│ ┌────────────────────────────┐ ┌──────────────────┐ │
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │
│ │ Main CLI binary / cobra │ │ WebAssembly target │
│ └──────┬─────────────────────┘ └──────────────────┘ │
│ │ imports: cli, workflow, parser, console, constants │
└──────────────────────┼───────────────────────────────────────────────────────────────────────────────┘
┌──────────────────────▼───────────────────────────────────────────────────────────────────────────────┐
Copy link

Copilot AI Apr 27, 2026

Choose a reason for hiding this comment

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

The ENTRY POINTS ASCII diagram is currently malformed/inaccurate for cmd/gh-aw-wasm: line 15 is missing the closing right border (), and the diagram doesn’t show cmd/gh-aw-wasm importing pkg/parser + pkg/workflow (see cmd/gh-aw-wasm/main.go imports). Please fix the box alignment and add the correct dependency annotation/connection for the wasm entry point.

Suggested change
│ ┌────────────────────────────┐ ┌──────────────────┐ │
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │
│ │ Main CLI binary / cobra │ │ WebAssembly target │
│ └──────┬─────────────────────┘ └──────────────────┘ │
│ │ imports: cli, workflow, parser, console, constants │
└──────────────────────┼───────────────────────────────────────────────────────────────────────────────┘
┌──────────────────────▼───────────────────────────────────────────────────────────────────────────────┐
│ ┌────────────────────────────┐ ┌────────────────────────┐ │
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │
│ │ Main CLI binary / cobra │ │ WebAssembly target │ │
│ └──────┬─────────────────────┘ └──────────┬─────────────┘ │
│ │ imports: cli, workflow, parser, console, constants │
│ │ │ imports: workflow, parser │
└──────────────────────┼─────────────────────────────────┼─────────────────────────────────────────────┘
│ │
┌──────────────────────▼─────────────────────────────────▼─────────────────────────────────────────────┐

Copilot uses AI. Check for mistakes.
@github-actions github-actions Bot mentioned this pull request Apr 27, 2026
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