Skip to content

[plan] Fix PR review comments default value mismatch #6257

Description

@github-actions

Objective

Resolve the mismatch between schema documentation (default: 1) and code implementation (default: 10) for the safe-outputs.create-pull-request-review-comment.max field.

Context

Severity: HIGH - Users reading the schema expect 1 PR review comment by default, but the runtime creates up to 10, causing unexpected behavior.

Current State:

  • Schema (pkg/parser/schemas/main_workflow_schema.json): Description says (default: 1)
  • Code (pkg/workflow/safe_outputs_config.go:675): Sets maxValue := 10

Decision Required

Choose one approach:

Option A: Update schema to match code

  • Change schema description from (default: 1) to (default: 10)
  • Preserves current runtime behavior

Option B: Update code to match schema

  • Change code from maxValue := 10 to maxValue := 1
  • Makes runtime match documented behavior

Recommended Approach

Option A is recommended because:

  • Changing the default to 1 would be a breaking change
  • Current default of 10 is more practical for code reviews
  • Schema documentation is easier to update than user workflows

Files to Modify

  • pkg/parser/schemas/main_workflow_schema.json - Update the description for safe-outputs.create-pull-request-review-comment.max

Acceptance Criteria

AI generated by Plan Command for discussion #6199

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions