Conversation
Add README.md specifications for the three packages that were missing documentation: - pkg/cli: CLI command implementations for the gh aw extension including all command groups (add, compile, run, audit, logs, mcp, update, etc.), key types, and exported functions - pkg/parser: Markdown frontmatter parsing, import resolution, GitHub URL handling, schema validation, and schedule parsing - pkg/workflow: Workflow compilation, validation, engine integration, safe-outputs, and GitHub Actions YAML generation — the compilation core Each README follows W3C specification style with types, functions, usage examples, design decisions, and dependency documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
automation
documentation
pelikhan
deleted the
spec-extractor/add-cli-parser-workflow-readmes-165b68fad0a9d4b5
branch
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Package Specification Updates
This PR adds
README.mdspecifications for three packages that were missing documentation, identified as Priority 2 (no existing README.md) in the round-robin spec-extractor run.pkg/clipkg/parserpkg/workflowWhat Changed
pkg/cli/README.md: Comprehensive specification covering all 30+ command groups (add,compile,run,audit,logs,mcp,update,health,fix,trial,deps, etc.), key config/options/result types, and exported functions. Includes usage examples and design philosophy notes.pkg/parser/README.md: Full specification of the frontmatter parsing pipeline — extraction, import processing, GitHub URL parsing, remote fetching, MCP configuration extraction, schedule parsing, JSON schema validation, and error formatting. Includes the parse-to-compile architecture diagram.pkg/workflow/README.md: Largest specification covering the compilation engine, engine interface hierarchy (Engine, CapabilityProvider, WorkflowExecutor, etc.), frontmatter config types, permissions system, tools configuration, safe outputs, network permissions, action pinning, YAML utilities, secret handling, and the full workflow compilation pipeline. Includes architecture diagram.Extraction Method
grep -n "^func [A-Z]\|^type [A-Z]")pkg/parser/doc.go)Round-Robin State
cli,parser,workflowcli,parser,workflow(3/20)Auto-generated by Package Specification Extractor workflow (§24394465007)