Skip to content

[spec-extractor] Update package specifications for cli and constants#27166

Merged
pelikhan merged 1 commit intomainfrom
spec-extractor/run-2026-04-19-2a2a85d6e2b90389
Apr 19, 2026
Merged

[spec-extractor] Update package specifications for cli and constants#27166
pelikhan merged 1 commit intomainfrom
spec-extractor/run-2026-04-19-2a2a85d6e2b90389

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Package Specification Updates

This PR updates README.md specifications for the following packages:

Package Status Changes
cli Updated Added 60+ missing exported functions, 80+ missing exported types
constants Updated Added DefaultGitHubToolsLocal/DefaultGitHubToolsRemote; noted DefaultGitHubTools deprecation

What Changed

pkg/cli/README.md

The cli package has 224+ exported types and 150+ exported functions, but the existing README only documented ~25 types and ~45 functions. This PR adds:

  • 60+ missing exported functions organized by domain:

    • Shell completion helpers (ValidEngineNames, CompleteWorkflowNames, RegisterEngineFlagCompletion, etc.)
    • Log analysis (ParseCopilotCodingAgentLogMetrics, ExtractLogMetricsFromRun)
    • Display helpers (DisplayOutdatedDependencies, DisplayDependencyReport, DisplaySecurityAdvisories)
    • Docker utilities (IsDockerAvailable, StartDockerImageDownload, CheckAndPrepareDockerImages)
    • Workflow content helpers (ExtractWorkflowDescription, UpdateFieldInFrontmatter, SetFieldInOnTrigger, etc.)
    • MCP helpers (ScanWorkflowsForMCP, ListToolsForMCP)
    • ML/anomaly detection (TrainDrain3Weights)
    • Lock-file cache (CollectLockFileManifests, WritePriorManifestFile)
    • Run management (GroupRunsByWorkflow, WaitForWorkflowCompletion)
    • PR operations (CreatePRWithChanges, AutoMergePullRequestsCreatedAfter)
  • 80+ missing exported types in a new "Additional Exported Types" section, covering:

    • Access log analysis types (AccessLogEntry, AccessLogSummary)
    • Audit comparison types (AuditComparisonData, BehaviorFingerprint, etc.)
    • Episode/agent turn types (EpisodeData, EpisodeEdge, etc.)
    • Gateway log types (GatewayLogEntry, GatewayMetrics)
    • MCP types (MCPConfig, MCPFailureReport, MCPToolCall, etc.)
    • Trial and devcontainer types
    • Type aliases (ArtifactSet, ShellType, CheckState, LogMetrics, etc.)

pkg/constants/README.md

  • Added DefaultGitHubToolsLocal — default tools for local (Docker) mode
  • Added DefaultGitHubToolsRemote — default tools for remote (hosted) mode
  • Noted that DefaultGitHubTools is deprecated in favour of DefaultGitHubToolsLocal or DefaultGitHubToolsRemote

Round-Robin State

  • Packages processed this run: agentdrain (unchanged), cli (updated), console (unchanged), constants (updated)
  • Next packages in rotation: envutil, fileutil, gitutil, logger
  • Total packages: 20
  • Coverage: All 20 packages have specifications (4 verified/updated this run)

Extraction Method

  • Source code analysis of all exported symbols (grep "^func [A-Z]\|^type [A-Z]")
  • Cross-referenced against existing README content
  • Signatures verified against source files
  • Descriptions written from doc comments and source context

Auto-generated by Package Specification Extractor workflow §24626843000

Generated by Package Specification Extractor · ● 3.9M ·

  • expires on Apr 22, 2026, 10:32 AM UTC

- cli: add 60+ missing exported functions (completion helpers, log
  analysis, display helpers, docker utilities, workflow content helpers,
  MCP helpers, drain3/ML, PR operations, and more)
- cli: add 80+ missing exported types (access logs, audit comparison,
  episode data, gateway metrics, MCP types, trial types, etc.)
- constants: add DefaultGitHubToolsLocal and DefaultGitHubToolsRemote
  to Tool Lists section; note DefaultGitHubTools is deprecated in favour
  of the more specific Local/Remote variants

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor Author

Hey @github-actions[bot] 👋 — great work keeping the package specifications up to date! The additions to pkg/cli/README.md (60+ exported functions and 80+ exported types) and the deprecation notice for DefaultGitHubTools in pkg/constants/README.md look well-structured and clearly described.

One minor note for completeness:

  • No test changes detected — this is a documentation-only PR, so there's nothing functionally testable here. If the spec extraction workflow itself isn't already covered by integration tests, it might be worth adding a smoke test that verifies the extractor runs without error.

If you'd like a hand addressing that:

Add a smoke test for the Package Specification Extractor workflow that:
1. Runs the extractor against the pkg/cli and pkg/constants packages.
2. Asserts the output README files are non-empty and contain expected section headings.
3. Verifies no exported symbols are silently dropped between runs (regression guard).
Place the test in the appropriate test file under the workflow's test directory.

Generated by Contribution Check · ● 1.5M ·

@pelikhan pelikhan merged commit ced34e8 into main Apr 19, 2026
@pelikhan pelikhan deleted the spec-extractor/run-2026-04-19-2a2a85d6e2b90389 branch April 19, 2026 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation pkg-specifications

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant