Skip to content

[architecture] Update architecture diagram - 2026-04-23#28017

Merged
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-04-23-f419f3cfaed32518
Apr 23, 2026
Merged

[architecture] Update architecture diagram - 2026-04-23#28017
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-04-23-f419f3cfaed32518

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Updates scratchpad/architecture.md with a refreshed architecture diagram reflecting the current package structure as of commit c292442.

Changes

  • Redrawn ASCII diagram with clearer layer separation and dependency arrows
  • Updated package descriptions (notably agentdrain described as log analysis/anomaly detection rather than "drain & streaming")
  • Moved constants and types to Utility layer (they have no downstream core-package dependencies)
  • Added pkg/envutil, pkg/repoutil, pkg/stats, pkg/timeutil explicitly to the diagram's utility row

Full analysis posted in the architecture issue created alongside this PR.

Generated by Architecture Diagram Generator · ● 732.1K ·

  • expires on Apr 30, 2026, 9:23 AM UTC

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 23, 2026
@pelikhan pelikhan marked this pull request as ready for review April 23, 2026 12:06
Copilot AI review requested due to automatic review settings April 23, 2026 12:06
@pelikhan pelikhan merged commit 85ec3d7 into main Apr 23, 2026
3 checks passed
@pelikhan pelikhan deleted the architecture-diagram-2026-04-23-f419f3cfaed32518 branch April 23, 2026 12:07
@github-actions github-actions Bot mentioned this pull request Apr 23, 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

Updates the scratchpad/architecture.md architecture diagram and package reference to reflect the current package layout and intended layering.

Changes:

  • Redraws the ASCII architecture diagram with clearer layer separation.
  • Reclassifies pkg/constants and pkg/types into the Utility layer and expands the Utility row.
  • Updates package descriptions (notably pkg/agentdrain) in the package reference table.
Show a summary per file
File Description
scratchpad/architecture.md Refreshes the architecture diagram and package reference content to match current structure/layers.

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

Comment on lines +32 to +36
│ └──────┬─────┘ └──────────────────────┘ └────────┬────────┘ └──────────┬───────────┘ │
│ │ │ │ │
│ ▼ │ │ │
│ ┌─────────────────────────────────────┐ │ │ │
│ │ pkg/parser │◀────────────┘ │ │
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

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

The dependency arrow into pkg/parser appears to indicate pkg/actionpins depends on pkg/parser, but in the codebase pkg/workflow imports both pkg/parser and pkg/actionpins (e.g. pkg/workflow/compiler_types.go), while pkg/actionpins does not import pkg/parser (see pkg/actionpins/actionpins.go). Please update the diagram arrows to reflect the actual import direction (workflow → parser, workflow → actionpins) and remove the implied actionpins → parser dependency.

Suggested change
│ └──────┬─────┘ └──────────────────────┘ └────────┬────────┘ └──────────┬───────────┘ │
│ │ │ │ │
│ ▼ │ │ │
│ ┌─────────────────────────────────────┐ │ │ │
│ │ pkg/parser │◀────────────┘ │ │
│ └──────┬─────┘ └──────────────────────┘ └────────▲────────┘ └──────────┬───────────┘ │
│ │ │ │ │
│ ├───────────────────────────────────────────┘ │ │
│ ▼ │ │
│ ┌─────────────────────────────────────┐ │ │
│ │ pkg/parser │ │ │

Copilot uses AI. Check for mistakes.
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │
│ │ (CLI binary) │ │ (WASM target) │ │
│ └──────────┬──────────┘ └──────────┬──────────┘ │
│ │ cli, workflow, parser, console │ │
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

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

The entry-point dependency list under cmd/gh-aw omits pkg/constants, and cmd/gh-aw-wasm's imports aren’t shown at all. In the code, cmd/gh-aw/main.go imports pkg/constants, and cmd/gh-aw-wasm/main.go imports pkg/parser and pkg/workflow. Please adjust the entry-point dependency line(s) so the diagram reflects these actual imports.

Suggested change
│ │ cli, workflow, parser, console
│ │ cli, workflow, parser, console, constants parser, workflow

Copilot uses AI. Check for mistakes.
# Architecture Diagram

> Last updated: 2026-04-22 · Source: [Issue #27791](https://github.com/github/gh-aw/issues)
> Last updated: 2026-04-23 · Source: Issue #28016 (Architecture Diagram)
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

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

The updated source reference is no longer a clickable link. Consider linking Issue #28016 directly (e.g. to /issues/28016) to match how issue references are typically navigated from docs.

Suggested change
> Last updated: 2026-04-23 · Source: Issue #28016 (Architecture Diagram)
> Last updated: 2026-04-23 · Source: [Issue #28016](/issues/28016) (Architecture Diagram)

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