Skip to content

[instructions] Document create-issue allowed-fields and fields runtime parameter - #31319

Merged
pelikhan merged 1 commit into
mainfrom
instructions-sync-v0.71.5-create-issue-fields-08a8d023a37c8609
May 10, 2026
Merged

pelikhan merged 1 commit into
mainfrom
instructions-sync-v0.71.5-create-issue-fields-08a8d023a37c8609

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Instructions Update — Synchronized with v0.71.5

Sync .github/aw/safe-outputs.md with create_issue safe-output behavior already shipped in v0.71.x.

Files Changed

  • .github/aw/safe-outputs.md — added two missing items to the create-issue: section:
    • Config option: allowed-fields: [Priority, Iteration] to restrict which issue fields the agent may set
    • Runtime tool parameter: documented the fields: [{name, value}, ...] array on create_issue agent output for setting custom field values on creation, with a JSON example

Why

Commit 8f3a4ab ('Add fields + allowed-fields support to create_issue safe output') added these capabilities to the compiler (pkg/workflow/create_issue.go:17) and the workflow JSON schema (pkg/parser/schemas/main_workflow_schema.json:4844). The user-facing reference (docs/src/content/docs/reference/safe-outputs.md) already documents both, but the agent-facing instruction file did not — agents writing workflows would not know to expose these to users.

Audit Coverage

  • Compared SafeOutputsConfig struct in pkg/workflow/compiler_types.go against the operations table in safe-outputs.md. All other YAML-keyed operations are present and accurate.
  • comment-memory lives under tools: (extracted via extractCommentMemoryConfig), not directly under safe-outputs:, and is correctly documented in memory.md and syntax.md.
  • set-issue-field, dispatch_repository, report-incomplete, actions, scripts, jobs all match their code-level definitions.

Size Audit

File Before After Status
safe-outputs.md 1007 lines 1014 lines within < 1100 limit
github-agentic-workflows.md 193 lines 193 lines within < 250 limit

Validation

  • Imperative mood, minimal example
  • Routed to the dedicated sub-file (safe-outputs.md), not the main file
  • No duplication introduced — content fits inline with the existing create-issue block
  • File sizes within target limits
  • Verified against pkg/workflow/create_issue.go, pkg/parser/schemas/main_workflow_schema.json, and the public reference docs

Generated by Instructions Janitor · ● 15.5M · ◷

  • expires on May 12, 2026, 9:10 AM UTC

…ime `fields` parameter

Sync .github/aw/safe-outputs.md with create_issue safe-output behavior shipped
in v0.71.x: the YAML config accepts `allowed-fields:` to restrict which issue
fields the agent may set, and the runtime tool call accepts a `fields` array
for setting custom field values immediately after issue creation.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation instructions labels May 10, 2026
@pelikhan
pelikhan merged commit aa26e02 into main May 10, 2026
@pelikhan
pelikhan deleted the instructions-sync-v0.71.5-create-issue-fields-08a8d023a37c8609 branch May 10, 2026 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation instructions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant