Skip to content

Add missing errorutil package spec and align dependency sections in package READMEs#32822

Merged
pelikhan merged 2 commits into
mainfrom
copilot/specification-audit-fix
May 17, 2026
Merged

Add missing errorutil package spec and align dependency sections in package READMEs#32822
pelikhan merged 2 commits into
mainfrom
copilot/specification-audit-fix

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 17, 2026

The spec audit reported a missing package specification for pkg/errorutil and dependency-list drift in pkg/cli and pkg/parser specs. This PR closes those documentation gaps so package specs reflect current imports.

  • Add missing package specification

    • Introduced pkg/errorutil/README.md with:
      • package overview
      • public API table (IsNotFoundError)
      • usage example
      • dependencies and design notes
      • standard spec-extractor footer
  • Align dependency declarations with actual usage

    • Updated pkg/cli/README.md dependencies to include:
      • github.com/github/gh-aw/pkg/errorutil
    • Updated pkg/parser/README.md dependencies to include:
      • github.com/github/gh-aw/pkg/errorutil
    • repoutil and stringutil remain explicitly listed in pkg/cli/README.md as expected by the audit.
  • Spec/API example added for errorutil

    import "github.com/github/gh-aw/pkg/errorutil"
    
    if errorutil.IsNotFoundError(err) {
        // Handle missing resource path
    }

Copilot AI linked an issue May 17, 2026 that may be closed by this pull request
4 tasks
Copilot AI changed the title [WIP] Fix issues found in package specification audit Add missing errorutil package spec and align dependency sections in package READMEs May 17, 2026
Copilot AI requested a review from gh-aw-bot May 17, 2026 13:58
@pelikhan pelikhan marked this pull request as ready for review May 17, 2026 14:01
Copilot AI review requested due to automatic review settings May 17, 2026 14:01
@pelikhan pelikhan merged commit 7eb13a4 into main May 17, 2026
@pelikhan pelikhan deleted the copilot/specification-audit-fix branch May 17, 2026 14:01
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

Adds a missing package specification README for pkg/errorutil and aligns the dependency lists in the pkg/cli and pkg/parser package READMEs to reflect their actual imports of errorutil.

Changes:

  • Add new pkg/errorutil/README.md documenting the IsNotFoundError helper, usage, and design notes.
  • Add pkg/errorutil to the dependency lists in pkg/cli/README.md and pkg/parser/README.md.
Show a summary per file
File Description
pkg/errorutil/README.md New package spec describing the IsNotFoundError helper and its design.
pkg/cli/README.md Adds errorutil to the internal dependencies list.
pkg/parser/README.md Adds errorutil to the internal dependencies list.

Copilot's findings

Tip

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

  • Files reviewed: 3/3 changed files
  • Comments generated: 0

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.

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

4 participants