Uh oh!
There was an error while loading. Please reload this page.
Refresh stale package specs and add linters doc drift guard - #46257
Merged
Conversation
6 tasks
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>
CopilotAI
changed the title
[WIP] Audit specification for 8 packages with outdated updatesRefresh stale package specs and add linters doc drift guardJul 17, 2026
pelikhan
marked this pull request as ready for review
July 18, 2026 05:31
Contributor
There was a problem hiding this comment.
Pull request overview
Refreshes package specifications and adds a test guard against linter documentation drift.
Changes:
- Documents
PinContextfields andmapclearloop. - Marks six package specifications as source-reviewed.
- Compares analyzer listings across linter documentation.
Show a summary per file
| File | Description |
|---|---|
pkg/actionpins/README.md | Documents PinContext fields. |
pkg/cli/README.md | Adds source synchronization note. |
pkg/constants/README.md | Adds source synchronization note. |
pkg/linters/README.md | Documents mapclearloop. |
pkg/linters/doc_sync_test.go | Adds analyzer-list parity guard. |
pkg/modelsdev/README.md | Adds source synchronization note. |
pkg/parser/README.md | Adds source synchronization note. |
pkg/semverutil/README.md | Adds source synchronization note. |
pkg/workflow/README.md | Adds source synchronization note. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 9/9 changed files
- Comments generated: 2
- Review effort level: Medium
| | `AllowActionRefs` | `bool` | Downgrades unresolved pinning failures to warnings | | ||
| | `Warnings` | `map[string]bool` | Shared warning dedupe map keyed by `repo@version` | | ||
| | `RecordResolutionFailure` | `func(ResolutionFailure)` | Optional callback for unresolved pinning events | | ||
| | `SkipHardcodedFallback` | `bool` | Skips version→SHA hardcoded fallback after dynamic resolver failure while preserving SHA→version labeling | |
Comment on lines
+71
to
+84
| readmeTableRe := regexp.MustCompile(`^\|\s+` + "`" + `([a-z0-9-]+)` + "`" + `\s+\|`) | ||
| for line := range strings.SplitSeq(string(readmeBytes), "\n") { | ||
| if !strings.HasPrefix(line, "| `") { | ||
| continue | ||
| } | ||
| m := readmeTableRe.FindStringSubmatch(line) | ||
| if m == nil { | ||
| continue | ||
| } | ||
| if m[1] == "internal" { | ||
| continue | ||
| } | ||
| readmeSet[m[1]] = struct{}{} | ||
| } |
Contributor
🎉 This pull request is included in a new release. Release: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The spec-librarian audit reported documentation drift across package specs, including missing
PinContext.SkipHardcodedFallbackand a missingmapclearloopanalyzer entry. This PR updates stale package READMEs and adds a guard to keeppkg/linters/README.mdandpkg/linters/doc.goaligned.Spec parity updates (
pkg/actionpins,pkg/linters)PinContextfields table inpkg/actionpins/README.md, includingSkipHardcodedFallback.mapclearlooptopkg/linters/README.mdacross overview, subpackage API table, and dependency listing.Stale spec refreshes (source-synced READMEs)
pkg/cli/README.mdpkg/constants/README.mdpkg/modelsdev/README.mdpkg/parser/README.mdpkg/semverutil/README.mdpkg/workflow/README.mdDrift prevention for linters docs
pkg/linters/doc_sync_test.gowith a new check that compares analyzer names in:doc.gobullet listREADME.mdsubpackages table