Skip to content

Close specification coverage gaps for actionpins/stats and sync README APIs for workflow/parser/cli#26520

Merged
pelikhan merged 3 commits intomainfrom
copilot/fix-specification-audit-issues
Apr 15, 2026
Merged

Close specification coverage gaps for actionpins/stats and sync README APIs for workflow/parser/cli#26520
pelikhan merged 3 commits intomainfrom
copilot/fix-specification-audit-issues

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 15, 2026

The package specification audit reported two missing package READMEs and API drift in three existing package specs. This PR fills the missing specs and aligns exported API documentation with current code.

  • Add missing package specifications

    • Added pkg/actionpins/README.md with package overview, public types/functions, dependencies, and thread-safety notes.
    • Added pkg/stats/README.md documenting StatVar behavior and all exported methods.
  • Sync workflow engine docs with current API

    • Updated pkg/workflow/README.md to include Gemini in engine overview/registry.
    • Added GeminiEngine and NewGeminiEngine() to public API tables.
  • Sync parser docs with newly exported helpers

    • Updated pkg/parser/README.md with the 9 missing exported functions from:
      • virtual_fs.go
      • tools_merger.go
      • workflow_update.go
  • Sync CLI docs with exported action command functions

    • Updated pkg/cli/README.md to document:
      • ActionsBuildCommand
      • ActionsValidateCommand
      • ActionsCleanCommand
      • GenerateActionMetadataCommand
// Newly documented parser API examples
func RegisterBuiltinVirtualFile(path string, content []byte)
func MergeTools(base, additional map[string]any) (map[string]any, error)
func UpdateWorkflowFrontmatter(workflowPath string, updateFunc func(frontmatter map[string]any) error, verbose bool) error

Copilot AI linked an issue Apr 15, 2026 that may be closed by this pull request
5 tasks
Copilot AI changed the title [WIP] Fix specification audit issues found on 2026-04-15 Close specification coverage gaps for actionpins/stats and sync README APIs for workflow/parser/cli Apr 15, 2026
Copilot AI requested a review from pelikhan April 15, 2026 23:52
@pelikhan pelikhan marked this pull request as ready for review April 15, 2026 23:56
Copilot AI review requested due to automatic review settings April 15, 2026 23:56
@pelikhan pelikhan merged commit 61a9fdc into main Apr 15, 2026
65 of 67 checks passed
@pelikhan pelikhan deleted the copilot/fix-specification-audit-issues branch April 15, 2026 23:57
@github-actions github-actions bot mentioned this pull request Apr 16, 2026
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 missing package specifications and synchronizes several package READMEs so their documented public APIs match the current exported Go code (per the spec audit).

Changes:

  • Added missing package specs for pkg/actionpins and pkg/stats.
  • Updated pkg/workflow docs to include the Gemini engine in the overview and public API tables.
  • Updated pkg/parser and pkg/cli docs to include newly exported helper/command functions.
Show a summary per file
File Description
pkg/workflow/README.md Documents Gemini as a supported workflow engine and adds it to the engine API tables.
pkg/stats/README.md New package spec documenting StatVar and its exported methods/behavior.
pkg/parser/README.md Adds missing exported helper functions (virtual FS, tools merge, workflow frontmatter update) to the public API table.
pkg/cli/README.md Documents exported action-related CLI command functions.
pkg/actionpins/README.md New package spec documenting action pin resolution types/functions and thread-safety notes.

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: 3

Comment thread pkg/stats/README.md
Comment on lines +27 to +30
| `Variance` | `func() float64` | Returns population variance (`N` denominator) |
| `SampleVariance` | `func() float64` | Returns sample variance (`N-1` denominator) |
| `StdDev` | `func() float64` | Returns population standard deviation |
| `SampleStdDev` | `func() float64` | Returns sample standard deviation |
Comment thread pkg/parser/README.md

| Function | Signature | Description |
|----------|-----------|-------------|
| `RegisterBuiltinVirtualFile` | `func(path string, content []byte)` | Registers embedded virtual file content under an `@builtin:` path |
Comment thread pkg/parser/README.md
Comment on lines +156 to +157
| `GetBuiltinFrontmatterCache` | `func(path string) (*FrontmatterResult, bool)` | Gets cached frontmatter parse results for built-in virtual files |
| `SetBuiltinFrontmatterCache` | `func(path string, result *FrontmatterResult) *FrontmatterResult` | Stores a frontmatter parse result in the built-in cache |
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-04-15 — 4 issues found

3 participants