Skip to content

[architecture] Update architecture diagram - 2026-05-18#33006

Merged
pelikhan merged 1 commit into
mainfrom
architecture-update-2026-05-18-275e1bddb46f71bf
May 18, 2026
Merged

[architecture] Update architecture diagram - 2026-05-18#33006
pelikhan merged 1 commit into
mainfrom
architecture-update-2026-05-18-275e1bddb46f71bf

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Adds three packages that were missing from the previous architecture diagram (2026-05-11):

  • cmd/linters — custom linter binary entry point
  • pkg/linters — namespace for custom Go analysis linters (ctxbackground, excessivefuncparams, largefunc, osexitinlibrary, rawloginlib)
  • pkg/errorutil — GitHub API/gh CLI error classification utilities

Updates scratchpad/architecture.md with the corrected diagram and package reference table.

Source: §26026605299

Generated by 🏗️ Architecture Diagram Generator · ● 12.5M ·

  • expires on May 25, 2026, 10:08 AM UTC

…errorutil

Add three packages that were missing from the previous diagram:
- cmd/linters: custom linter binary entry point
- pkg/linters: namespace for custom Go analysis linters
- pkg/errorutil: GitHub API error classification utilities

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review May 18, 2026 12:44
Copilot AI review requested due to automatic review settings May 18, 2026 12:44
@pelikhan pelikhan merged commit c3c76d1 into main May 18, 2026
4 checks passed
@pelikhan pelikhan deleted the architecture-update-2026-05-18-275e1bddb46f71bf branch May 18, 2026 12:44
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 generated architecture diagram to reflect recently added/recognized packages and refreshes the “last updated” metadata.

Changes:

  • Add cmd/linters as a third entry point in the diagram and package reference table.
  • Add pkg/linters (namespace + subpackages) and pkg/errorutil to the diagram and package reference table.
  • Update the “Last updated” date and workflow run source link.
Show a summary per file
File Description
scratchpad/architecture.md Updates the architecture diagram and package reference table to include missing entry points/utilities and refreshes metadata.

Copilot's findings

Tip

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

Comments suppressed due to low confidence (1)

scratchpad/architecture.md:98

  • In the package reference table, pkg/errorutil is described as "GitHub API error classification helpers", but the package docs cover both GitHub API and gh CLI errors. Consider reflecting both sources here for consistency with pkg/errorutil’s README and package comment.
| `pkg/errorutil` | Utility | GitHub API error classification helpers |
  • Files reviewed: 1/1 changed files
  • Comments generated: 2

Comment on lines +14 to +18
│ │ cmd/gh-aw │ cmd/gh-aw-wasm cmd/linters
│ │ Main CLI binary │ │ WebAssembly build target Custom linter binary
└──────────┬────────────┘ └────────────┬───────────────┘ └────────────┬─────────────────┘
│ cli,workflow, │ pkg/linters/*
│ parser,console,constants
Comment on lines +67 to +68
│ │ pkg/errorutil │ │ pkg/testutil (test builds only)
│ │ GitHub API error classification │ Test helper utilities
@github-actions github-actions Bot mentioned this pull request May 18, 2026
Copy link
Copy Markdown
Contributor Author

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Skills-Based Review 🧠

Applied /grill-with-docs — this is a documentation update adding three previously-missing packages to the architecture diagram.

What was reviewed

Verified each new entry against the actual codebase:

  • cmd/linters — exists at cmd/linters/
  • pkg/linters — exists at pkg/linters/ with all five subpackages (ctxbackground, excessivefuncparams, largefunc, osexitinlibrary, rawloginlib) correctly listed
  • pkg/errorutil — exists at pkg/errorutil/

Positive Highlights

  • ✅ Diagram layout correctly places cmd/linters alongside the other entry points
  • ✅ Package reference table uses consistent terminology and column format
  • pkg/linters subpackages are named accurately
  • pkg/errorutil is correctly categorised as Utility (not Core)

Verdict

All additions are accurate and consistent with the existing domain vocabulary. No issues found.

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · ● 3.7M

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