[Schema Consistency] Safe-Outputs Schema Completeness Analysis

[github-actions[bot]]

Schema Completeness for Safe-Outputs Operations

Summary

The schema completeness analysis reveals MISMATCHES BETWEEN SCHEMA $COMMENT AND ACTUAL SCHEMA PROPERTIES. Specifically, the $comment field is missing four operations that are fully defined in the schema.

---

Key Finding: Missing Operations from $comment

The $comment field in properties["safe-outputs"] lists operations that should be documented but is INCOMPLETE. Four operations are defined in the schema but NOT listed in the $comment:

1. assign-to-user - Fully defined in schema with properties: allowed, blocked, max, target, target-repo, unassign-first, github-token
2. unassign-from-user - Fully defined in schema with properties: allowed, blocked, max, target, target-repo, allowed-repos, github-token
3. create-project - Fully defined in schema with properties: max, github-token, target-owner, title-prefix, views, field-definitions
4. missing-data - Fully defined in schema with properties: max, create-issue, title-prefix, labels, github-token

Note: missing-tool IS listed in $comment (along with missing-data), so that one is correct.

---

Schema Properties Inventory

All Safe-Outputs Properties (48 total)

Output Operations (40):

• add-comment, add-labels, add-reviewer, assign-milestone, assign-to-agent, assign-to-user
• autofix-code-scanning-alert, close-discussion, close-issue, close-pull-request
• create-agent-session, create-agent-task, create-code-scanning-alert, create-discussion, create-issue, create-project, create-project-status-update
• create-pull-request, create-pull-request-review-comment
• dispatch-workflow, hide-comment, link-sub-issue
• mark-pull-request-as-ready-for-review, missing-data, missing-tool, noop
• push-to-pull-request-branch, remove-labels
• reply-to-pull-request-review-comment, resolve-pull-request-review-thread
• submit-pull-request-review, threat-detection
• unassign-from-user, update-discussion, update-issue, update-project
• update-pull-request, update-release, upload-asset

Configuration Properties (8):

• allowed-domains, allowed-github-references, app, env, footer, github-token, group-reports, jobs, max-patch-size, mentions, messages, runs-on, staged

---

Struct Fields in Go Implementation

BaseSafeOutputConfig (inherited by all)

• Max (int) - Maximum operations (YAML: max)
• GitHubToken (string) - Token override (YAML: github-token)
• Staged (bool) - Step summary mode (YAML: staged)

Operation-Specific Structs

AssignToUserConfig (pkg/workflow/assign_to_user.go)

• BaseSafeOutputConfig (embedded)
• SafeOutputTargetConfig (embedded)
• Allowed ([]string) - Allowed users
• Blocked ([]string) - Blocked users/patterns
• UnassignFirst (bool) - Unassign before assigning

UnassignFromUserConfig (pkg/workflow/unassign_from_user.go)

• BaseSafeOutputConfig (embedded)
• SafeOutputTargetConfig (embedded)
• Allowed ([]string) - Allowed users
• Blocked ([]string) - Blocked users/patterns

CreateProjectsConfig (pkg/workflow/create_project.go)

• BaseSafeOutputConfig (embedded)
• GitHubToken (string) - Token override
• TargetOwner (string) - Default project owner (YAML: target-owner)
• TitlePrefix (string) - Project title prefix (YAML: title-prefix)
• Views ([]ProjectView) - Project views to create (YAML: views)
• FieldDefinitions ([]ProjectFieldDefinition) - Custom fields (YAML: field-definitions)

MissingDataConfig (pkg/workflow/missing_data.go)

• BaseSafeOutputConfig (embedded)
• CreateIssue (bool) - Create issues (YAML: create-issue)
• TitlePrefix (string) - Issue title prefix (YAML: title-prefix)
• Labels ([]string) - Issue labels (YAML: labels)

MissingToolConfig (pkg/workflow/missing_tool.go)

• BaseSafeOutputConfig (embedded)
• CreateIssue (bool) - Create issues (YAML: create-issue)
• TitlePrefix (string) - Issue title prefix (YAML: title-prefix)
• Labels ([]string) - Issue labels (YAML: labels)

NoOpConfig (pkg/workflow/noop.go)

• BaseSafeOutputConfig (embedded)
• ReportAsIssue (bool) - Report as issue comments (YAML: report-as-issue)

---

Schema vs Implementation Analysis

Complete Alignment (All 4 operations)

assign-to-user:

• Schema properties: allowed, blocked, max, target, target-repo, unassign-first, github-token ✓
• Go fields: Allowed, Blocked, Max (via BaseSafeOutputConfig), SafeOutputTargetConfig.Target, SafeOutputTargetConfig.TargetRepo, UnassignFirst, GitHubToken
• Status: COMPLETE

unassign-from-user:

• Schema properties: allowed, blocked, max, target, target-repo, allowed-repos, github-token ✓
• Go fields: Allowed, Blocked, Max, SafeOutputTargetConfig.Target, SafeOutputTargetConfig.TargetRepo, SafeOutputTargetConfig.AllowedRepos, GitHubToken
• Status: COMPLETE

create-project:

• Schema properties: max, github-token, target-owner, title-prefix, views, field-definitions ✓
• Go fields: Max, GitHubToken, TargetOwner, TitlePrefix, Views, FieldDefinitions
• Status: COMPLETE

**missing-(redacted)

• Schema properties: max, create-issue, title-prefix, labels, github-token ✓
• Go fields: Max, CreateIssue, TitlePrefix, Labels, GitHubToken (via BaseSafeOutputConfig)
• Status: COMPLETE

---

Documentation Coverage

From /home/runner/work/gh-aw/gh-aw/docs/src/content/docs/reference/safe-outputs.md:

• assign-to-user - ✓ Documented (line 52)
• unassign-from-user - ✓ Documented (line 53)
• create-project - ✓ Documented (line 57)
• missing-data - ✓ Documented (line 74)

All four operations are properly documented with descriptions.

---

Recommendations

1. Update the schema $comment to include the four missing operations:

   • Add assign-to-user
   • Add unassign-from-user
   • Add create-project
   • Add missing-data (already has missing-tool)

2. Current $comment is missing these operations from its list - while they are properly defined as schema properties and implemented in Go, they should be listed in the $comment for consistency and clarity.

3. All schema properties, Go struct fields, and documentation are aligned - only the $comment documentation string needs updating.

---

Reference Files

• Schema: /home/runner/work/gh-aw/gh-aw/pkg/parser/schemas/main_workflow_schema.json
• Go implementations:
  • /home/runner/work/gh-aw/gh-aw/pkg/workflow/assign_to_user.go
  • /home/runner/work/gh-aw/gh-aw/pkg/workflow/unassign_from_user.go
  • /home/runner/work/gh-aw/gh-aw/pkg/workflow/create_project.go
  • /home/runner/work/gh-aw/gh-aw/pkg/workflow/missing_data.go
  • /home/runner/work/gh-aw/gh-aw/pkg/workflow/missing_tool.go
• Compiler types: /home/runner/work/gh-aw/gh-aw/pkg/workflow/compiler_types.go
• Documentation: /home/runner/work/gh-aw/gh-aw/docs/src/content/docs/reference/safe-outputs.md

AI generated by Schema Consistency Checker

• expires on Feb 28, 2026, 10:03 AM UTC

[github-actions[bot]]

🤖 Smoke test was here! The Copilot agent dropped by discussion #17442 to leave this totally-not-automated friendly note. Everything's working great — or at least that's what I'm programmed to say. 🚀✨

📰 BREAKING: Report filed by Smoke Copilot

[github-actions[bot]]

💥 WHOOSH! 🦸 THE SMOKE TEST AGENT WAS HERE! 💨

Panel 1: "KA-POW! Claude's smoke test swoops into discussion #17442!"
Panel 2: "With the power of 17 tests, I validated MCP tools, builds, and PR reviews!"
Panel 3: "ZZZAP! All systems nominal — the agentic workflows hold strong!"

🎯 MISSION COMPLETE — Smoke Test Run 22255965551 signing off! 💫

💥 [THE END] — Illustrated by Smoke Claude

[pelikhan]

/plan

[github-actions[bot]]

This discussion identified that the $comment field in the safe-outputs schema is missing four operations: assign-to-user, unassign-from-user, create-project, and missing-data.

A sub-issue has been created to fix this: update pkg/parser/schemas/main_workflow_schema.json to add the four missing operations to the $comment string. All four operations are already fully implemented in Go and documented — only the $comment annotation needs updating.