Skip to content

docs: close spec-librarian API drift findings across 5 package READMEs#32629

Merged
pelikhan merged 2 commits into
mainfrom
copilot/aw-package-specification-librarian-fix
May 16, 2026
Merged

docs: close spec-librarian API drift findings across 5 package READMEs#32629
pelikhan merged 2 commits into
mainfrom
copilot/aw-package-specification-librarian-fix

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 16, 2026

The Package Specification Librarian run failed after identifying API drift: 14 exported symbols were present in source but missing from package specs across typeutil, stringutil, constants, console, and linters. This PR updates those package READMEs so the documented public surface matches current exports.

  • Type conversion spec completeness (pkg/typeutil)

    • Added an explicit exported-function inventory covering all public helpers, including previously missing lookup/path utilities and safe uint conversions.
  • String utility API completeness (pkg/stringutil)

    • Documented missing public items: NormalizeLeadingWhitespace, FormatList, SanitizeOptions, and SanitizeName.
    • Added a small exported-types section to make SanitizeOptions discoverable.
  • Version-gating constants coverage (pkg/constants)

    • Added missing minimum-version constants for firewall feature gating:
      • AWFDockerHostPathPrefixMinVersion
      • AWFTokenSteeringMinVersion
  • Console public surface alignment (pkg/console)

    • Added missing exports to the API table:
      • BannerStyle
      • SpinnerWrapper
  • Linter namespace coverage (pkg/linters)

    • Added osexitinlibrary as a documented subpackage and included osexitinlibrary.Analyzer in usage/API descriptions.
// Newly documented linter analyzer usage
import "github.com/github/gh-aw/pkg/linters/osexitinlibrary"

_ = osexitinlibrary.Analyzer

Copilot AI linked an issue May 16, 2026 that may be closed by this pull request
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix Package Specification Librarian failure docs: close spec-librarian API drift findings across 5 package READMEs May 16, 2026
Copilot AI requested a review from pelikhan May 16, 2026 14:35
@pelikhan pelikhan marked this pull request as ready for review May 16, 2026 14:38
Copilot AI review requested due to automatic review settings May 16, 2026 14:38
@pelikhan pelikhan merged commit 2d9f6b4 into main May 16, 2026
@pelikhan pelikhan deleted the copilot/aw-package-specification-librarian-fix branch May 16, 2026 14:38
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

Updates package README specifications to eliminate documented/public API drift across several pkg/* packages so the documented surfaces match the current exported Go symbols.

Changes:

  • Added missing exported symbol inventories and sections to typeutil and stringutil READMEs.
  • Documented newly missing exported constants in constants and exports in console.
  • Added osexitinlibrary subpackage to linters README with usage guidance.
Show a summary per file
File Description
pkg/typeutil/README.md Adds an exported-functions inventory covering all current public helpers.
pkg/stringutil/README.md Documents missing exports (NormalizeLeadingWhitespace, FormatList, SanitizeOptions, SanitizeName) and adds an exported-types section.
pkg/linters/README.md Documents the osexitinlibrary analyzer subpackage and includes it in the API/usage sections.
pkg/constants/README.md Adds missing minimum-version constants for AWF feature gating to the documented list.
pkg/console/README.md Adds missing exported items (BannerStyle, SpinnerWrapper) to the public API table.

Copilot's findings

Tip

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

  • Files reviewed: 5/5 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.

[aw] Package Specification Librarian failed

3 participants