Skip to content

[architecture] Update architecture diagram - 2026-03-31#23657

Merged
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-03-31-d3e80b4578023d3c
Mar 31, 2026
Merged

[architecture] Update architecture diagram - 2026-03-31#23657
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-03-31-d3e80b4578023d3c

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Full rebuild of the architecture diagram from HEAD 98b01af (2026-03-31).

Changes

  • Added missing pkg/semverutil to the package reference table
  • Refreshed diagram layout to accurately show dependency directions: cmd/gh-awpkg/clipkg/workflowpkg/parser, with pkg/console used by all core packages
  • Annotated cmd/gh-aw-wasm as importing only pkg/parser and pkg/workflow (no cobra/CLI layer)
  • Updated metadata header (date, run reference)
  • Reorganized shared primitives section to clarify pkg/constants and pkg/types have zero internal dependencies

Packages (21 total)

2 entry points · 4 core · 2 shared primitives · 13 utilities (including 1 test-only)

References:

Note

🔒 Integrity filter blocked 1 item

The following item were blocked because they don't meet the GitHub integrity level.

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Architecture Diagram Generator ·

  • expires on Apr 7, 2026, 9:15 AM UTC

Add pkg/semverutil to package reference, refresh diagram layout
to show actual dependency directions (cli→workflow→parser, console←all),
and update entry point annotations.

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 Mar 31, 2026
@pelikhan pelikhan marked this pull request as ready for review March 31, 2026 11:55
Copilot AI review requested due to automatic review settings March 31, 2026 11:55
@pelikhan pelikhan merged commit a966d7c into main Mar 31, 2026
1 check passed
@pelikhan pelikhan deleted the architecture-diagram-2026-03-31-d3e80b4578023d3c branch March 31, 2026 11:55
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

Rebuilds and refreshes the gh-aw architecture diagram documentation to reflect the current package set and intended dependency structure as of 2026-03-31.

Changes:

  • Updates the diagram header metadata (date + workflow run link) and redraws the ASCII dependency diagram.
  • Expands and reorganizes the package reference table (including adding pkg/semverutil).
  • Reframes shared primitives (pkg/constants, pkg/types) and utilities grouping in the diagram.
Comments suppressed due to low confidence (2)

scratchpad/architecture.md:38

  • The diagram lists pkg/semver, but the repository has pkg/semverutil/ (and the package reference table below uses pkg/semverutil). This looks like an outdated/incorrect package name in the utilities row—please update the diagram label to match the actual package directory/name so readers can find it.
│  ┌──────────┐ ┌─────────────┐ ┌────────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐          │
│  │pkg/envutil│ │pkg/repoutil │ │pkg/sliceutil│ │pkg/semver│ │pkg/timeutil│ │pkg/mathutil│       │
│  └──────────┘ └─────────────┘ └────────────┘ └──────────┘ └──────────┘ └──────────┘          │

scratchpad/architecture.md:23

  • The arrow between pkg/parser and pkg/console currently points toward pkg/parser, implying pkg/console depends on pkg/parser. In code, pkg/parser imports pkg/console (and pkg/cli/pkg/workflow do too), so the dependency direction should be toward pkg/console (or use a non-directional annotation if the intent is just “console is used by core packages”).
│  │   pkg/cli    │──▶ │    pkg/workflow       │──▶ │      pkg/parser      │   │  pkg/console   │ │
│  │  Command     │    │  Workflow compilation │    │  Markdown/YAML       │ ◀─│  Terminal UI   │ │
│  │  impls       │    │  engine               │    │  parsing             │   │  rendering     │ │

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

Comment on lines +13 to +16
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │
│ │ GitHub CLI extension binary │ │ WebAssembly target │ │
│ └──────┬──────────────────────┬────────────┘ └──────────────────┬──────────────────────┘ │
│ │ │ │ │
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

The diagram implies cmd/gh-aw depends only on pkg/cli (and possibly pkg/workflow), and that cmd/gh-aw-wasm has a single dependency. However, cmd/gh-aw/main.go directly imports pkg/cli, pkg/console, pkg/constants, pkg/parser, and pkg/workflow, and cmd/gh-aw-wasm/main.go imports both pkg/parser and pkg/workflow. If this diagram is meant to reflect actual package import dependencies (per the overview text), please update the entry-point edges/annotations accordingly; otherwise clarify that the diagram is a simplified layer view.

This issue also appears in the following locations of the same file:

  • line 21
  • line 36

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