Skip to content

Document missing internal dependencies in parser, cli, and workflow specs - #51380

Merged
pelikhan merged 2 commits into
mainfrom
copilot/spec-librarian-audit-issues
Aug 8, 2026
Merged

Document missing internal dependencies in parser, cli, and workflow specs#51380
pelikhan merged 2 commits into
mainfrom
copilot/spec-librarian-audit-issues

Conversation

CopilotAI commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

The spec-librarian audit found three package specs whose ## Dependencies sections had drifted from the actual non-test imports. This is a documentation-only change.

Changes

  • pkg/parser/README.md — added syncutil (OnceLoader for lazy schema compilation in schema_compiler.go)
  • pkg/cli/README.md — added colorwriter (Degrade in compile_schedule_calendar.go), ctxutil, and githubapi (ClientOptions in update_check.go)
  • pkg/workflow/README.md — added ctxutil (OrBackground in auto_update_workflow.go, compiler_model_pricing.go, github_cli_wasm.go)

Descriptions reuse the wording already established for these packages elsewhere in the specs.

Notes for reviewers

The audit also flagged stringutil as undocumented in pkg/parser/README.md, but it was already present — no change was needed there.

Each addition was checked against real usage sites rather than taken from the report. Coverage was verified by diffing documented entries against actual imports:

forpin parser cli workflow;do
go list -deps=false -f '{{range .Imports}}{{println .}}{{end}}' ./pkg/$p \
| grep '^github.com/github/gh-aw/pkg'| sort -u \
|whileread i;do grep -q "$i\`" pkg/$p/README.md ||echo"MISSING: $i";donedone

All three packages now report zero missing entries.

Two audit action items are intentionally not addressed here: the shallow-clone/git-history item concerns the audit workflow's checkout configuration rather than package specs, and issue linking is handled separately.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
CopilotAI changed the title [WIP] Resolve dependency mismatches in package specificationsDocument missing internal dependencies in parser, cli, and workflow specsAug 8, 2026
CopilotAI requested a review from pelikhanAugust 8, 2026 13:43
@pelikhan
pelikhan marked this pull request as ready for review August 8, 2026 15:00
CopilotAI balanced review requested due to automatic review settings August 8, 2026 15:00
@pelikhan
pelikhan merged commit 2f96e76 into mainAug 8, 2026
@pelikhan
pelikhan deleted the copilot/spec-librarian-audit-issues branch August 8, 2026 15:01

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates package specifications to resolve dependency-documentation gaps identified in issue #51379.

Changes:

  • Documents syncutil in the parser specification.
  • Documents colorwriter, ctxutil, and githubapi in the CLI specification.
  • Documents ctxutil in the workflow specification.
Show a summary per file
FileDescription
pkg/parser/README.mdAdds the parser’s syncutil dependency.
pkg/cli/README.mdAdds three missing CLI internal dependencies.
pkg/workflow/README.mdAdds the workflow package’s ctxutil dependency.

Review details

Tip

Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Balanced

@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.86.2

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[spec-librarian] Specification Audit — 2026-08-08 — 3 issues found

3 participants

@pelikhan