Repository navigation
Audit package specifications and document connector APIs - #77159
Conversation
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. See the comment below for the result and any generated ADR draft. Design Decision Gate 🏗️Outcome: The agent completed and reported no action. A no-op output alone does not verify that all required work was completed or that publication was possible. Agent messages are omitted from this comment. The category uses structured run status, not interpretation of agent prose.
|
|
✅ Ponytail Reviewer completed successfully! Ponytail ReviewerOutcome: The agent completed and reported no action. A no-op output alone does not verify that all required work was completed or that publication was possible. Agent messages are omitted from this comment. The category uses structured run status, not interpretation of agent prose.
|
|
✅ PR Specification Reviewer completed successfully! PR Specification ReviewerOutcome: The agent completed and reported no action. A no-op output alone does not verify that all required work was completed or that publication was possible. Agent messages are omitted from this comment. The category uses structured run status, not interpretation of agent prose.
|
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅
|
|
✅ Test Quality Sentinel completed test quality analysis. Test Quality SentinelOutcome: The agent completed and reported no action. A no-op output alone does not verify that all required work was completed or that publication was possible. Agent messages are omitted from this comment. The category uses structured run status, not interpretation of agent prose.
|
|
✅ PR Code Quality Reviewer completed the code quality review. PR Code Quality ReviewerOutcome: The agent completed and reported one or more actions. The no-op output is a completion signal, not a claim that no action was taken. Agent messages are omitted from this comment. The category uses structured run status, not interpretation of agent prose.
|
There was a problem hiding this comment.
🟡 Changes recommended
Two active documentation issues remain: the connectors README misidentifies Select as a package-level export, and the lint README omits the exported CachePoisoningRule from its rule table.
2 open issues
What changed in this PR
Audits package specifications and expands API documentation across connector, workflow, CLI, workqueue, compiler-environment, parser, and lint packages.
Changes:
- Adds the missing connectors README with runtime API coverage and a link to the detailed contract.
- Removes phantom and obsolete symbols and corrects stale source attributions.
- Documents connector declarations, workqueue types, compiler expression builders, CLI commands, and built-in lint rules.
| File | Description |
|---|---|
| pkg/workqueue/README.md | Documents retry, pool, trace, and native delivery types. |
| pkg/workflow/README.md | Removes obsolete exports, corrects source-file references, and documents connector declarations. |
| pkg/workflow/lint/README.md | Adds a reference table for built-in lint rule constructors. |
| pkg/workflow/compilerenv/README.md | Documents exported runtime expression builders. |
| pkg/parser/README.md | Updates source synchronization history and removes obsolete API entries. |
| pkg/connectors/README.md | Adds the connector package overview, contract link, security boundaries, and public API summary. |
| pkg/cli/README.md | Documents connector command constructors and removes phantom exports. |
Review effort: Lite (auto)
| | Symbol | Description | | ||
| |--------|-------------| | ||
| | `ConnectorSpec`, `Connection`, `Binding` | Validated source documents and selected capability bindings. | | ||
| | `Service`, `Selection`, `NewService`, `LoadService`, `Select` | Construct or load a service and select capabilities into a plan. | |
| | Policy area | Rule constructors | | ||
| |-------------|-------------------| | ||
| | Expressions and secrets | `TemplateInjectionRule`, `PromptExpressionRule`, `SecretLeakRule`, `OTLPSecretLeakRule` | | ||
| | Actions and workflow integrity | `ActionPinRule`, `VersionCheckRule`, `JobTimeoutRule`, `NeedsConsistencyRule`, `StepReferenceRule` | |
|
🎉 This pull request is included in a new release. Release: |

The specification audit found a missing
pkg/connectorsREADME, stale API entries and source attributions, and undocumented high-value exports across several packages.CONTRACT.mdfor the detailed contract.