Skip to content

[architecture] Update architecture diagram - 2026-04-03#24264

Merged
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-04-03-119c61cac9ed6498
Apr 3, 2026
Merged

[architecture] Update architecture diagram - 2026-04-03#24264
pelikhan merged 1 commit intomainfrom
architecture-diagram-2026-04-03-119c61cac9ed6498

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Apr 3, 2026

Updates scratchpad/architecture.md with the incremental architecture diagram reflecting changes since f5a2c2a.

What changed

  • Added internal/tools/ tier to the Entry Points layer:
    • internal/tools/actions-build — build/validate custom GitHub Actions
    • internal/tools/generate-action-metadata — generate action.yml and README.md for JS modules
  • Both tools import pkg/cli, extending its role beyond the main CLI binary
  • Refreshed diagram layout with cleaner box widths
  • Added internal/tools rows to the Package Reference table

Source

Generated by the architecture diagram workflow run §23940712069.

Generated by Architecture Diagram Generator · ● 1.1M ·

  • expires on Apr 10, 2026, 9:07 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 3, 2026
@pelikhan pelikhan marked this pull request as ready for review April 3, 2026 13:35
Copilot AI review requested due to automatic review settings April 3, 2026 13:35
@pelikhan pelikhan merged commit 55b80b8 into main Apr 3, 2026
2 checks passed
@pelikhan pelikhan deleted the architecture-diagram-2026-04-03-119c61cac9ed6498 branch April 3, 2026 13:36
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 gh-aw architecture documentation to reflect newly added internal tooling entry points and a refreshed diagram layout.

Changes:

  • Adds an internal/tools/ tier (actions-build, generate-action-metadata) to the Entry Points layer in the diagram.
  • Refreshes diagram formatting/layout for readability.
  • Extends the Package Reference table with the two internal tools.

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

# Architecture Diagram

> Last updated: 2026-03-31 · Source: [Run §23789178746](https://github.com/github/gh-aw/actions/runs/23789178746)
> Last updated: 2026-04-03 · Source: [Issue #aw_arch01](https://github.com/github/gh-aw/issues)
Copy link

Copilot AI Apr 3, 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 and URL look incorrect: it references "Issue #aw_arch01" but links to the generic issues list (…/gh-aw/issues) rather than a specific issue or the workflow run that generated the diagram (as described in the PR). Please update this to the correct source (e.g., link directly to the generating run or a real issue URL).

Copilot uses AI. Check for mistakes.
Comment on lines +12 to +15
│ ┌────────────────────────────┐ ┌────────────────────────┐ ┌────────────────────────────────┐ │
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │ internal/tools/ (×2) │ │
│ │ GitHub CLI extension bin │ │ WebAssembly target │ │ actions-build, gen-metadata │ │
│ └────────────┬───────────────┘ └────────────┬───────────┘ └──────────────┬─────────────────┘ │
Copy link

Copilot AI Apr 3, 2026

Choose a reason for hiding this comment

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

In the diagram, the internal tool is abbreviated as "gen-metadata", but elsewhere (and in the package reference table) it's named "generate-action-metadata". Consider using the full tool name here (or a consistently used abbreviation) to avoid confusion when cross-referencing packages.

Suggested change
│ ┌────────────────────────────┐ ┌────────────────────────┐ ┌────────────────────────────────┐ │
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │ internal/tools/ (×2) │ │
│ │ GitHub CLI extension bin │ │ WebAssembly target │ │ actions-build, gen-metadata │ │
│ └────────────┬───────────────┘ └────────────┬───────────┘ └───────────────────────────────┘ │
│ ┌────────────────────────────┐ ┌────────────────────────┐ ┌──────────────────────────────────────────────┐ │
│ │ cmd/gh-aw │ │ cmd/gh-aw-wasm │ │ internal/tools/ (×2) │ │
│ │ GitHub CLI extension bin │ │ WebAssembly target │ │ actions-build, generate-action-metadata │ │
│ └────────────┬───────────────┘ └────────────┬───────────┘ └─────────────────────┬────────────────────────┘ │

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