Skip to content

[spec-librarian] Specification Audit — 2026-05-31 — 4 issues found #36127

@github-actions

Description

@github-actions

📚 Package Specification Audit Report

Date: 2026-05-31
Total Packages: 26
Packages with Specs: 26
Coverage: 100%


Coverage Summary

All 26 packages under pkg/ have a README.md specification. ✅


✅ Staleness Check

No stale specifications detected. All README.md files share the same commit date (2026-05-31) as their corresponding source files.


🔄 Cross-Package Inconsistencies

4 naming issues were detected — abbreviated internal dependency paths in specs instead of the canonical full module path.

View inconsistencies (4 packages)

Abbreviated Dependency Paths

The following packages document their internal dependencies using the short form pkg/logger instead of the canonical full path github.com/github/gh-aw/pkg/logger. All other README.md files in pkg/ consistently use the full canonical path.

Package Current (incorrect) Expected (canonical)
errorutil pkg/logger github.com/github/gh-aw/pkg/logger
sliceutil pkg/logger github.com/github/gh-aw/pkg/logger
stats pkg/logger github.com/github/gh-aw/pkg/logger
syncutil pkg/logger github.com/github/gh-aw/pkg/logger

Recommendation: Update each affected README.md to replace pkg/logger with github.com/github/gh-aw/pkg/logger in the Dependencies → Internal section.


📊 Quality Scores

Package Completeness Accuracy Consistency Freshness Overall
actionpins 95% 95% 100% 100% ✅ 97%
agentdrain 95% 95% 100% 100% ✅ 97%
cli 95% 95% 100% 100% ✅ 97%
console 95% 95% 100% 100% ✅ 97%
constants 95% 95% 100% 100% ✅ 97%
envutil 95% 95% 100% 100% ✅ 97%
errorutil 95% 95% 75% 100% ⚠️ 91%
fileutil 95% 95% 100% 100% ✅ 97%
gitutil 95% 95% 100% 100% ✅ 97%
jsonutil 95% 95% 100% 100% ✅ 97%
linters 95% 95% 100% 100% ✅ 97%
logger 95% 95% 100% 100% ✅ 97%
parser 95% 95% 100% 100% ✅ 97%
repoutil 95% 95% 100% 100% ✅ 97%
semverutil 95% 95% 100% 100% ✅ 97%
sliceutil 95% 95% 75% 100% ⚠️ 91%
stats 95% 95% 75% 100% ⚠️ 91%
stringutil 95% 95% 100% 100% ✅ 97%
styles 95% 95% 100% 100% ✅ 97%
syncutil 95% 95% 75% 100% ⚠️ 91%
testutil 95% 95% 100% 100% ✅ 97%
timeutil 95% 95% 100% 100% ✅ 97%
tty 95% 95% 100% 100% ✅ 97%
types 95% 95% 100% 100% ✅ 97%
typeutil 95% 95% 100% 100% ✅ 97%
workflow 95% 95% 100% 100% ✅ 97%

Action Items

  • Fix abbreviated pkg/logger path in pkg/errorutil/README.md → use github.com/github/gh-aw/pkg/logger
  • Fix abbreviated pkg/logger path in pkg/sliceutil/README.md → use github.com/github/gh-aw/pkg/logger
  • Fix abbreviated pkg/logger path in pkg/stats/README.md → use github.com/github/gh-aw/pkg/logger
  • Fix abbreviated pkg/logger path in pkg/syncutil/README.md → use github.com/github/gh-aw/pkg/logger
  • 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: §26714262987

📚 Specification review by Package Specification Librarian · sonnet46 2M ·

  • expires on Jun 3, 2026, 1:50 PM UTC

Metadata

Metadata

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions