Skip to content

Refresh stale package specs and add linters doc drift guard#46257

Draft
pelikhan with Copilot wants to merge 4 commits into
mainfrom
copilot/spec-librarian-audit-2026-07-17
Draft

Refresh stale package specs and add linters doc drift guard#46257
pelikhan with Copilot wants to merge 4 commits into
mainfrom
copilot/spec-librarian-audit-2026-07-17

Conversation

Copilot AI commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

The spec-librarian audit reported documentation drift across package specs, including missing PinContext.SkipHardcodedFallback and a missing mapclearloop analyzer entry. This PR updates stale package READMEs and adds a guard to keep pkg/linters/README.md and pkg/linters/doc.go aligned.

  • Spec parity updates (pkg/actionpins, pkg/linters)

    • Added a dedicated PinContext fields table in pkg/actionpins/README.md, including SkipHardcodedFallback.
    • Added mapclearloop to pkg/linters/README.md across overview, subpackage API table, and dependency listing.
  • Stale spec refreshes (source-synced READMEs)

    • Refreshed stale specs for:
      • pkg/cli/README.md
      • pkg/constants/README.md
      • pkg/modelsdev/README.md
      • pkg/parser/README.md
      • pkg/semverutil/README.md
      • pkg/workflow/README.md
    • Added source-synchronization notes to capture current alignment with recent source changes.
  • Drift prevention for linters docs

    • Extended pkg/linters/doc_sync_test.go with a new check that compares analyzer names in:
      • doc.go bullet list
      • README.md subpackages table
    • Fails on mismatch to enforce simultaneous updates.
func TestDocGo_AnalyzersMatchREADME(t *testing.T) {
    // parses analyzer names from doc.go and README.md
    // asserts the sorted sets are identical
}

Copilot AI and others added 3 commits July 17, 2026 14:00
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Audit specification for 8 packages with outdated updates Refresh stale package specs and add linters doc drift guard Jul 17, 2026
Copilot AI requested a review from pelikhan July 17, 2026 14:31
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-07-17 — 9 issues found

2 participants