Skip to content

[WIP] Fix phantom functions in specification audit - #55415

Closed
pelikhan with Copilot wants to merge 1 commit into
mainfrom
copilot/spec-librarian-audit-2026-08-24
Closed

[WIP] Fix phantom functions in specification audit#55415
pelikhan with Copilot wants to merge 1 commit into
mainfrom
copilot/spec-librarian-audit-2026-08-24

Conversation

Copilot AI commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Thanks for asking me to work on this. I will get started on it and keep this PR's description up to date as I form a plan and make progress.


This section details on the original issue you should resolve

<issue_title>[spec-librarian] Specification Audit - 2026-08-24 - 1 issue found</issue_title>
<issue_description>### 📚 Package Specification Audit Report

Date: 2026-08-24
Total Packages: 36
Packages with Specs: 36
Coverage: 100%

Note: this repository checkout is a shallow clone (single commit visible in git log), so date-based staleness detection (spec vs. source last-modified) could not be performed this run. Findings below are based on direct content/symbol verification instead.


Coverage Summary

All 36 packages under pkg/ have a README.md. No missing specifications this run.


❌ Phantom Functions (documented but do not exist in source)

pkg/workflow/README.md documents 3 functions that are not present in the current source code (verified via grep across pkg/workflow/*.go):

Documented Function Documented Location Actual Status
BuildStandardNpmEngineInstallSteps nodejs.go Not found. Only BuildStandardNpmEngineInstallStepsNoCooldown exists (pkg/workflow/nodejs.go:71).
NewPermissionsContentsReadIssuesWritePRWrite permissions_factory.go Not found. Closest existing helpers: NewPermissionsContentsReadIssuesWrite and NewPermissionsContentsWritePRWrite (no combined three-way variant).
RunGHWithHost github_cli.go Not found. Closest existing function: RunGHContextWithHost (pkg/workflow/github_cli.go:228), which additionally takes a context.Context.

Recommendation: Re-run the spec-extractor for pkg/workflow to regenerate the API reference table, or manually correct these 3 entries to match the current function signatures/names.


🔄 Cross-Package Consistency

  • Import paths: All github.com/github/gh-aw/pkg/<name> references found across the 36 READMEs resolve to real package directories. No broken cross-package import references found.
  • Terminology: stdout/stderr usage was checked across specs mentioning I/O (cli, colorwriter, console, envutil, fileutil, logger, testutil, tty, workflow). No direct contradictions were found in this pass (e.g., no spec instructs writing user-facing output to stdout where another explicitly requires stderr for the same operation), but this check was surface-level given the shallow-clone limitation on cross-referencing history.

Action Items

  • Fix or regenerate the 3 phantom function entries in pkg/workflow/README.md (BuildStandardNpmEngineInstallSteps, NewPermissionsContentsReadIssuesWritePRWrite, RunGHWithHost)
  • When opening a fix PR for this issue, include Closes #<this issue number> (or Fixes/Resolves) in the PR description.

📚 Next review scheduled for tomorrow. Close this issue once all items are resolved.

📚 Specification review by Package Specification Librarian · copilot · auto · 54.1 AIC · ⌖ 5.57 AIC · ⊞ 8.9K ·

  • expires on Aug 27, 2026, 5:34 AM UTC-08:00

Comments on the Issue (you are @copilot in this section)

Sign up for free to 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-24 - 1 issue found

2 participants