Skip to content

[task] Document safe-outputs parameter limitations in schema #4027

@github-actions

Description

@github-actions

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

  1. Locate create-pull-request safe-output configuration in schema
  2. Add note about max parameter limitation
  3. Review if other safe-output types have similar limitations
  4. 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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions