Skip to content

Commit e1c9276

Browse files
committed
Skip endpoints marked with x-cli-skip in CLI coverage workflow
Updates the CLI coverage agent to check for x-cli-skip: true annotations in the openapi.yaml and skip those endpoints from CLI command generation. This allows internal endpoints (like the auth exchange endpoint used only by the hosted UI) to be excluded from CLI coverage requirements.
1 parent 8dc9875 commit e1c9276

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

.github/workflows/update-cli-coverage.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ jobs:
145145
- SDK api.md: Current directory - READ THIS FILE FIRST. This is the authoritative list of all SDK methods and their signatures.
146146
- SDK *.go files: Current directory - Contains param structs (e.g., BrowserNewParams, DeploymentListParams) with all available options/fields.
147147
- API Spec: /tmp/kernel-api/packages/api/stainless.yaml - SDK configuration with resources and methods
148-
- API Spec: /tmp/kernel-api/packages/api/openapi.yaml - Full OpenAPI specification
148+
- API Spec: /tmp/kernel-api/packages/api/openapi.yaml - Full OpenAPI specification. CHECK for x-cli-skip: true on endpoints - skip those from CLI coverage.
149149
- CLI: /tmp/kernel-cli - Existing CLI commands
150150
151151
# Task
@@ -287,7 +287,8 @@ jobs:
287287
# Constraints
288288
- ALWAYS update the SDK version in go.mod - this is the primary purpose
289289
- ALWAYS perform the full enumeration (Steps 2-4) - this is critical for finding gaps
290-
- ALL SDK methods in api.md MUST have corresponding CLI commands - no exceptions
290+
- ALL SDK methods in api.md MUST have corresponding CLI commands, EXCEPT those marked with x-cli-skip in openapi.yaml
291+
- SKIP endpoints marked with x-cli-skip: true in openapi.yaml - these are internal endpoints (e.g., hosted UI auth flows) not suitable for CLI
291292
- Streaming methods may have different CLI implementations (e.g., follow flags)
292293
- Even if no coverage gaps are found, still create a PR for the SDK version bump
293294
- Ensure code compiles before pushing

0 commit comments

Comments
 (0)