Skip to content

Align package specs with exported API surface in actionpins, parser, and workflow #27929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Apr 23, 2026
+10 −0
Merged

Align package specs with exported API surface in actionpins, parser, and workflow #27929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe031cf
Initial plan
Copilot Apr 22, 2026
cd65d24
chore: initialize plan for spec drift documentation updates
Copilot Apr 22, 2026
0581415
docs: document missing exported APIs in package READMEs
Copilot Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions pkg/actionpins/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Resolution supports two modes:
| `GetActionPins` | `func() []ActionPin` | Returns all loaded pins |
| `GetActionPinsByRepo` | `func(repo string) []ActionPin` | Returns all pins for a repository (version-descending) |
| `GetActionPinByRepo` | `func(repo string) (ActionPin, bool)` | Returns the latest pin for a repository |
| `GetContainerPin` | `func(image string) (ContainerPin, bool)` | Returns a pinned container image by its original image reference |
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This entry introduces GetContainerPin(...) (ContainerPin, bool), but ContainerPin itself isn’t listed in the Types table above. Since it’s part of the exported API surface (and now referenced in the public function list), add ContainerPin to the documented public types to keep the spec self-contained.

Copilot uses AI. Check for mistakes.
| `FormatReference` | `func(repo, sha, version string) string` | Formats a pinned reference (`repo@sha # version`) |
| `FormatCacheKey` | `func(repo, version string) string` | Formats a cache key (`repo@version`) |
| `ExtractRepo` | `func(uses string) string` | Extracts the repository from a `uses` reference |
Expand Down
1 change: 1 addition & 0 deletions pkg/parser/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ The package is designed for use both in the main CLI binary and in WebAssembly c
| `DownloadFileFromGitHubForHost` | `func(owner, repo, path, ref, host string) ([]byte, error)` | Downloads a file from a specific GitHub host |
| `ResolveRefToSHAForHost` | `func(owner, repo, ref, host string) (string, error)` | Resolves a branch/tag ref to a commit SHA |
| `ListWorkflowFiles` | `func(owner, repo, ref, workflowPath string) ([]string, error)` | Lists workflow files in a remote repository |
| `IsWorkflowSpec` | `func(path string) bool` | Returns whether a path is a workflow specification markdown file |
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The IsWorkflowSpec description is more specific than the implementation: it doesn’t check for a Markdown extension, it checks whether the string looks like a workflowspec-style remote reference (owner/repo/path with optional @ref and/or #section, and it also treats URL-like paths as workflowspecs). Please adjust the description to match the actual predicate.

Suggested change
| `IsWorkflowSpec` | `func(path string) bool` | Returns whether a path is a workflow specification markdown file |
| `IsWorkflowSpec` | `func(path string) bool` | Returns whether a path looks like a workflowspec-style remote reference (for example `owner/repo/path` with optional `@ref` and/or `#section`) or a URL-like path |

Copilot uses AI. Check for mistakes.

#### MCP Configuration

Expand Down
8 changes: 8 additions & 0 deletions pkg/workflow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ The package is intentionally large (~320 source files) because it encodes all Gi
| `ClaudeEngine` | struct | Claude coding agent engine |
| `CodexEngine` | struct | OpenAI Codex coding agent engine |
| `GeminiEngine` | struct | Google Gemini CLI coding agent engine |
| `CrushEngine` | struct | Crush coding agent engine |
| `OpenCodeEngine` | struct | OpenCode coding agent engine |
| `UniversalLLMBackend` | string alias | Universal LLM backend identifier (`claude`, `codex`) |
Copy link

Copilot AI Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UniversalLLMBackend values listed here don’t match the actual exported constants. In code it’s type UniversalLLMBackend string with constants copilot, anthropic, and codex (and openai maps to codex during parsing), not claude/codex. Update the documented identifier list to reflect the real supported values.

Suggested change
| `UniversalLLMBackend` | string alias | Universal LLM backend identifier (`claude`, `codex`) |
| `UniversalLLMBackend` | string alias | Universal LLM backend identifier (`copilot`, `anthropic`, `codex`; `openai` parses as `codex`) |

Copilot uses AI. Check for mistakes.
| `UniversalLLMConsumerEngine` | struct | Shared implementation for universal LLM backends |
| `EngineCatalog` | struct | Catalog of engine definitions with lookup and resolution helpers |

#### Engine Registry Functions

Expand All @@ -79,6 +84,9 @@ The package is intentionally large (~320 source files) because it encodes all Gi
| `NewClaudeEngine` | `func() *ClaudeEngine` | Creates the Claude engine |
| `NewCodexEngine` | `func() *CodexEngine` | Creates the Codex engine |
| `NewGeminiEngine` | `func() *GeminiEngine` | Creates the Gemini engine |
| `NewCrushEngine` | `func() *CrushEngine` | Creates the Crush engine |
| `NewOpenCodeEngine` | `func() *OpenCodeEngine` | Creates the OpenCode engine |
| `NewEngineCatalog` | `func(registry *EngineRegistry) *EngineCatalog` | Creates an engine catalog from an engine registry |

### Frontmatter Configuration Types

Expand Down
Loading