spec: add githubapi README + spec_test, fix workflow method signatures#47800
Merged
Conversation
5 tasks
- Add pkg/githubapi/README.md with specification for ClientOptions - Add pkg/githubapi/spec_test.go with behavioral contract tests - Fix pkg/workflow/README.md: update CompileWorkflow and CompileWorkflowData to show (*Compiler) receiver instead of bare func signatures Closes #47799 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix specification issues identified in audit report
spec: add githubapi README + spec_test, fix workflow method signatures
Jul 24, 2026
pelikhan
marked this pull request as ready for review
July 24, 2026 15:12
Contributor
There was a problem hiding this comment.
Pull request overview
Adds specification coverage for pkg/githubapi and corrects workflow compiler API documentation.
Changes:
- Documents
githubapi.ClientOptions. - Adds specification tests for its host, token, timeout, and GHES behavior.
- Corrects
Compilermethod signatures.
Show a summary per file
| File | Description |
|---|---|
pkg/githubapi/README.md |
Defines the package’s public contract and usage. |
pkg/githubapi/spec_test.go |
Verifies the documented contract. |
pkg/workflow/README.md |
Identifies compiler APIs as methods. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Medium
Contributor
|
🎉 This pull request is included in a new release. Release: |
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.
Spec audit found
pkg/githubapihad no README or spec tests, andpkg/workflow/README.mdincorrectly listedCompileWorkflow/CompileWorkflowDataas standalone functions rather than(*Compiler)methods.Changes
pkg/githubapi/README.md— new specification coveringClientOptions: behavioral contract, parameters, usage example, and dependency listpkg/githubapi/spec_test.go— spec tests validating the three documented contracts (Host, AuthToken, Timeout) plus GHES host handlingpkg/workflow/README.md— corrected method signatures in theCompiler Methodstable: