-
Notifications
You must be signed in to change notification settings - Fork 28
Closed
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationpriority-lowschematask
Description
Objective
Add documentation for safe-outputs configuration parameter limitations, specifically that pull requests don't support the max parameter (always limited to 1).
Context
Code comments indicate the max parameter is not supported for pull requests, but this limitation isn't documented in the schema. Users may try to configure max for PRs without knowing it's not applicable. Part of discussion #4010.
Current State
Code comment: pkg/workflow/safe_outputs.go
// Note: max parameter is not supported for pull requests (always limited to 1)Schema location: pkg/parser/schemas/main_workflow_schema.json - create-pull-request configuration
Implementation Steps
- Locate create-pull-request safe-output configuration in schema
- Add note about max parameter limitation
- Review if other safe-output types have similar limitations
- Document all discovered limitations
Proposed Changes
Add to create-pull-request schema description:
"Note: max parameter not applicable for pull requests (always limited to 1 PR per workflow run)"
Files to Modify
pkg/parser/schemas/main_workflow_schema.json- Update create-pull-request safe-output description
Additional Investigation
Check other safe-output types for similar limitations:
- create-issue
- create-discussion
- add-comment
- create-pull-request-review-comment
- update-issue
Acceptance Criteria
- create-pull-request schema documents max parameter limitation
- Any other safe-output parameter limitations are documented
- Documentation clearly explains why limitation exists
- Schema validation passes with
make test
Related Information
- Safe-outputs logic in
pkg/workflow/safe_outputs.go - This is a design decision to prevent workflow runs from creating excessive PRs
AI generated by Plan Command for discussion #4010
Copilot
Metadata
Metadata
Assignees
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationpriority-lowschematask