Skip to content

Specification Audit — 2026-05-17 — 4 issues found #32821

Closed

Description

@github-actions

📚 Package Specification Audit Report

Date: 2026-05-17
Total Packages: 25
Packages with Specs: 24
Coverage: 96%


Coverage Summary

Status Package Last Spec Update Last Source Update
✅ actionpins 2026-05-17 2026-05-17
✅ agentdrain 2026-05-17 2026-05-17
✅ cli 2026-05-17 2026-05-17
✅ console 2026-05-17 2026-05-17
✅ constants 2026-05-17 2026-05-17
✅ envutil 2026-05-17 2026-05-17
❌ errorutil — 2026-05-17
✅ fileutil 2026-05-17 2026-05-17
✅ gitutil 2026-05-17 2026-05-17
✅ jsonutil 2026-05-17 2026-05-17
✅ linters 2026-05-17 2026-05-17
✅ logger 2026-05-17 2026-05-17
✅ parser 2026-05-17 2026-05-17
✅ repoutil 2026-05-17 2026-05-17
✅ semverutil 2026-05-17 2026-05-17
✅ sliceutil 2026-05-17 2026-05-17
✅ stats 2026-05-17 2026-05-17
✅ stringutil 2026-05-17 2026-05-17
✅ styles 2026-05-17 2026-05-17
✅ testutil 2026-05-17 2026-05-17
✅ timeutil 2026-05-17 2026-05-17
✅ tty 2026-05-17 2026-05-17
✅ types 2026-05-17 2026-05-17
✅ typeutil 2026-05-17 2026-05-17
✅ workflow 2026-05-17 2026-05-17

🚨 Missing Specifications

The following packages have no README.md:

Package Imported By Priority
errorutil cli, parser High

Recommendation: Run the spec-extractor workflow to generate a specification for pkg/errorutil.


⚠️ Stale Specifications

No stale specifications found. All 24 specs share the same commit date as their source files (2026-05-17).


🔄 Cross-Package Inconsistencies

View dependency declaration issues (2 packages)

cli — 3 undocumented dependencies

The pkg/cli/README.md Dependencies section is missing the following packages that are actually imported in source:

  • github.com/github/gh-aw/pkg/errorutil — used in gateway_logs_mcp.go and others
  • github.com/github/gh-aw/pkg/repoutil — used in compile_workflow_processor.go and others
  • github.com/github/gh-aw/pkg/stringutil — used in update_merge.go, audit_cross_run_render.go, compile_workflow_processor.go

Recommendation: Add these three packages to the ## Dependencies section of pkg/cli/README.md.

parser — 1 undocumented dependency

The pkg/parser/README.md Dependencies section is missing:

  • github.com/github/gh-aw/pkg/errorutil — imported across parser source files

Recommendation: Add errorutil to the ## Dependencies section of pkg/parser/README.md.


📊 Quality Scores

Package Completeness Accuracy Consistency Freshness Overall
errorutil 0% 0% 0% 0% ❌ 0% — no spec
cli 90% 85% 80% 100% ⚠️ 88% — missing 3 deps in spec
parser 90% 85% 80% 100% ⚠️ 88% — missing 1 dep in spec
all others (22) 95%+ 90%+ 90%+ 100% ✅ 94%+

Action Items

  • Generate specification for pkg/errorutil (use spec-extractor workflow) — High priority, package is imported by cli and parser
  • Add errorutil, repoutil, stringutil to ## Dependencies in pkg/cli/README.md
  • Add errorutil to ## Dependencies in pkg/parser/README.md
  • 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.

References: §25992507321

📚 Specification review by Package Specification Librarian · ● 11.1M · ◷

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions