Skip to content

[plan] Update safe outputs schema reference documentation for issue fields #30887

@github-actions

Description

@github-actions

Objective

Update the safe outputs schema reference documentation to cover the new issue fields support added to create-issue, update-issue, set-issue-field, and the discovery mechanism.

Context

The current reference documents create-issue without fields. After the implementation issues are completed, documentation must be updated. Tracked in #30846.

Approach

  1. Review the existing docs in docs/ for safe outputs pages
  2. Update the create-issue schema table to include the fields parameter (type, required, description, example)
  3. Update the update-issue schema table similarly
  4. Add a new section for set-issue-field with parameter descriptions and examples
  5. Add a section for the field discovery mechanism with usage examples
  6. Add a code example showing an end-to-end workflow that discovers fields and sets them during triage

Files to Modify

  • docs/ — safe outputs reference page(s)
  • Add usage examples in workflow markdown format

Acceptance Criteria

  • create-issue reference includes fields parameter documentation with examples
  • update-issue reference includes fields parameter documentation
  • set-issue-field reference section added with full parameter table
  • Field discovery mechanism documented with examples
  • End-to-end workflow example included
  • Documentation passes CI validation
    Related to Implement Issue Fields Support in Safe Outputs #30846

Generated by Plan Command for issue #30846 · ● 3.1M ·

  • expires on May 9, 2026, 6:53 PM UTC

Metadata

Metadata

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions