[spec-extractor] Update package specifications for cli and constants#27166
Merged
[spec-extractor] Update package specifications for cli and constants#27166
Conversation
- 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>
Contributor
Author
|
Hey One minor note for completeness:
If you'd like a hand addressing that:
|
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
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 updates README.md specifications for the following packages:
cliconstantsDefaultGitHubToolsLocal/DefaultGitHubToolsRemote; notedDefaultGitHubToolsdeprecationWhat Changed
pkg/cli/README.mdThe
clipackage 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:
ValidEngineNames,CompleteWorkflowNames,RegisterEngineFlagCompletion, etc.)ParseCopilotCodingAgentLogMetrics,ExtractLogMetricsFromRun)DisplayOutdatedDependencies,DisplayDependencyReport,DisplaySecurityAdvisories)IsDockerAvailable,StartDockerImageDownload,CheckAndPrepareDockerImages)ExtractWorkflowDescription,UpdateFieldInFrontmatter,SetFieldInOnTrigger, etc.)ScanWorkflowsForMCP,ListToolsForMCP)TrainDrain3Weights)CollectLockFileManifests,WritePriorManifestFile)GroupRunsByWorkflow,WaitForWorkflowCompletion)CreatePRWithChanges,AutoMergePullRequestsCreatedAfter)80+ missing exported types in a new "Additional Exported Types" section, covering:
AccessLogEntry,AccessLogSummary)AuditComparisonData,BehaviorFingerprint, etc.)EpisodeData,EpisodeEdge, etc.)GatewayLogEntry,GatewayMetrics)MCPConfig,MCPFailureReport,MCPToolCall, etc.)ArtifactSet,ShellType,CheckState,LogMetrics, etc.)pkg/constants/README.mdDefaultGitHubToolsLocal— default tools for local (Docker) modeDefaultGitHubToolsRemote— default tools for remote (hosted) modeDefaultGitHubToolsis deprecated in favour ofDefaultGitHubToolsLocalorDefaultGitHubToolsRemoteRound-Robin State
agentdrain(unchanged),cli(updated),console(unchanged),constants(updated)envutil,fileutil,gitutil,loggerExtraction Method
grep "^func [A-Z]\|^type [A-Z]")Auto-generated by Package Specification Extractor workflow §24626843000