Skip to content

Audit package specifications and document connector APIs - #77159

Merged
pelikhan merged 2 commits into
mainfrom
copilot/spec-librarian-audit-2026-11-12
Nov 12, 2026
Merged

pelikhan merged 2 commits into
mainfrom
copilot/spec-librarian-audit-2026-11-12

Conversation

Copilot AI commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

The specification audit found a missing pkg/connectors README, stale API entries and source attributions, and undocumented high-value exports across several packages.

  • Connector spec: Add a package README summarizing the API and linking to CONTRACT.md for the detailed contract.
  • Specification accuracy: Remove phantom symbols and correct workflow source-file attributions; update the parser’s obsolete API history.
  • Export coverage: Document connector declarations, CLI connector commands, workqueue delivery and trace types, compilerenv expression builders, and key lint rules.

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix specification issues found in package audit Audit package specifications and document connector APIs Nov 12, 2026
Copilot AI requested a review from gh-aw-bot November 12, 2026 13:41
@pelikhan
pelikhan marked this pull request as ready for review November 12, 2026 14:05
Copilot AI dynamic review requested due to automatic review settings November 12, 2026 14:05
@pelikhan
pelikhan merged commit 97fff57 into main Nov 12, 2026
87 checks passed
@pelikhan
pelikhan deleted the copilot/spec-librarian-audit-2026-11-12 branch November 12, 2026 14:06
@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

✅ 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: reported_no_action

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.

Generated from Design Decision Gate 🏗️ · routed: haiku55 xhigh · ~1 AIC · ⌖ ~2 AIC · ⊞ 8.5K · ◷

🏗️ ADR gate enforced by Design Decision Gate 🏗️

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

✅ Ponytail Reviewer completed successfully!

Ponytail Reviewer

Outcome: reported_no_action

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.

Generated from Ponytail Reviewer · routed: gpt61 medium · ~6 AIC · ⌖ ~1 AIC · ⊞ 181 · ◷

Generated by Ponytail Reviewer for #77159

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

✅ PR Specification Reviewer completed successfully!

PR Specification Reviewer

Outcome: reported_no_action

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.

Generated from PR Specification Reviewer · gpt56 · ~1 AIC · ⌖ ~2 AIC · ⊞ 1.6K · ◷

Generated by PR Specification Reviewer for #77159

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

✅ Test Quality Sentinel completed test quality analysis.

Test Quality Sentinel

Outcome: reported_no_action

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.

Generated from Test Quality Sentinel · routed: haiku55 xhigh · ~1 AIC · ⌖ ~2 AIC · ⊞ 7.2K · ◷

🧪 Test quality analysis by Test Quality Sentinel

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

✅ PR Code Quality Reviewer completed the code quality review.

PR Code Quality Reviewer

Outcome: reported_action

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.

Generated from PR Code Quality Reviewer · gpt56 · ~3 AIC · ⌖ ~1 AIC · ⊞ 1.6K · ◷

🔎 Code quality review by PR Code Quality Reviewer

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 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)

Comment thread pkg/connectors/README.md
| 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` |
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v1.2.3

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.

[spec-librarian] Specification Audit — 2026-11-12 — 6 issues found

4 participants