Skip to content

Enhance safe outputs reference for issue field operations and discovery#31121

Merged
pelikhan merged 5 commits intomainfrom
copilot/update-safe-outputs-schema-reference
May 9, 2026
Merged

Enhance safe outputs reference for issue field operations and discovery#31121
pelikhan merged 5 commits intomainfrom
copilot/update-safe-outputs-schema-reference

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 9, 2026

This updates the safe outputs reference to document issue field support now available across issue creation and set-issue-field operations. It adds missing schema-level guidance for create-issue and set-issue-field, plus field discovery and triage usage patterns, and aligns update-issue docs with current behavior.

  • ✨ Enhancement

    • What does this improve?
      • Adds explicit fields parameter docs for create-issue (type, requiredness, semantics, examples).
      • Adds a dedicated set_issue_field parameter reference with conditional requirements (field_name vs field_node_id).
      • Documents field discovery flow, including unknown-field error behavior and explicit-ID fallback.
      • Adds an end-to-end triage example combining update_issue body updates with set_issue_field assignments.
      • Clarifies that issue field mutations should use set_issue_field (not update_issue).
    • Why is this valuable?
      • Aligns reference docs with shipped issue-field capabilities.
      • Reduces ambiguity for workflow authors using project/issue field automation.
    • Implementation approach:
      • Updated /docs/src/content/docs/reference/safe-outputs.md with new schema tables and targeted examples.
      • Kept update-issue focused on status/title/body updates and linked field updates to set_issue_field.
{
  "type": "set_issue_field",
  "issue_number": 123,
  "field_name": "Priority",
  "value": "High"
}

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update safe outputs schema reference documentation for issue fields Enhance safe outputs reference for issue field operations and discovery May 9, 2026
Copilot AI requested a review from pelikhan May 9, 2026 01:55
@pelikhan
Copy link
Copy Markdown
Collaborator

pelikhan commented May 9, 2026

@copilot review update_field updates

Copilot AI and others added 3 commits May 9, 2026 02:04
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
This reverts commit 879a494.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 9, 2026

@copilot review update_field updates

Updated in 41626be.

update_issue docs now match current behavior, and issue field mutations are documented via set_issue_field (including the triage example).

@pelikhan pelikhan marked this pull request as ready for review May 9, 2026 02:26
Copilot AI review requested due to automatic review settings May 9, 2026 02:26
@pelikhan pelikhan merged commit d11f754 into main May 9, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/update-safe-outputs-schema-reference branch May 9, 2026 02:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Safe Outputs reference documentation to reflect current support for GitHub Issue Fields across create_issue and set_issue_field, including schema guidance, discovery/error behavior, and a triage-oriented usage example.

Changes:

  • Documented create_issue.fields schema (including per-field name/value expectations) with an example payload.
  • Expanded set_issue_field documentation with a dedicated parameter schema and explained name-based discovery with an explicit-ID fallback flow.
  • Clarified update_issue guidance by pointing issue field mutations to set_issue_field, and added an end-to-end triage workflow example.
Show a summary per file
File Description
docs/src/content/docs/reference/safe-outputs.md Adds issue-field schema references, discovery/error guidance, and a triage example; links field updates to set_issue_field.
docs/src/content/docs/agent-factory-status.mdx Adds newly available agent workflows to the status table.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 2/2 changed files
  • Comments generated: 0

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants