[Schema Consistency] Schema Consistency Check – 2026-03-24 #22595
Closed
Replies: 1 comment
-
|
This discussion has been marked as outdated by Schema Consistency Checker. A newer discussion is available at Discussion #22830. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Summary
Two fully-implemented safe output types are invisible to users in the primary reference documentation (
safe-outputs.md), a new feature flag is completely undocumented, and a previously-reported schema description mismatch persists after conflicting changesets.Critical Issues
🔴 HIGH —
set-issue-typecompletely absent fromsafe-outputs.mdThe
set-issue-typesafe output type is fully production-ready — it has schema definitions, Go compiler code, CJS runtime handlers, and is listed in the schema$comment— but it has zero presence insafe-outputs.md, the primary user-facing reference.Evidence:
main_workflow_schema.json:6938— full object definition withallowed,max,target,target-repo,allowed-repos,stagedfieldscompiler_types.go:491,safe_outputs_config.go:290,compiler_safe_outputs_config.go:844,safe_outputs_config_generation.go:460,imports.go:339$commentat line 4381 explicitly listsset-issue-typein the "Operations requiring safe-outputs" listfrontmatter-full.md:4570— auto-generated YAML reference onlysafe-outputs.md— no section, not listed in ToC, zero occurrencesImpact: Users cannot discover that they can configure the AI agent to set/clear GitHub Issue types. The feature is entirely invisible unless a user reads raw schema or auto-generated reference YAML.
Fix: Add a
### Set Issue Type (set-issue-type:)section tosafe-outputs.mdunder the Issues & Discussions heading and include it in the ToC.🔴 HIGH —
mark-pull-request-as-ready-for-reviewcompletely absent fromsafe-outputs.mdSame situation: fully implemented, schema-defined, listed in the
$commentpermission list, but absent from the primary documentation.Evidence:
main_workflow_schema.json— full object withrequired-labels,required-title-prefix,target,max,target-repo,allowed-repos,stagedfieldsmark_pull_request_as_ready_for_review.go(dedicated file),compiler_types.go:464,compiler_safe_outputs_config.go:320,imports.go:323$commentat line 4381 explicitly listsmark-pull-request-as-ready-for-reviewfrontmatter-full.md:3166andsafe-outputs-specification.md:2731— presentsafe-outputs.md— no section, not listed in the Pull Requests ToC, zero occurrencessafe-outputs-pull-requests.md— also absentImpact: Users building draft-PR workflows cannot discover that the agent can convert draft PRs to ready-for-review. The
required-labels/required-title-prefixfilter fields are especially invisible.Fix: Add a
### Mark PR as Ready for Review (mark-pull-request-as-ready-for-review:)section tosafe-outputs.md(Pull Requests section) and include it in the ToC.Documentation Gaps
🟡 MEDIUM —
features.copilot-requestsflag completely undocumentedThe
CopilotRequestsFeatureFlag = "copilot-requests"feature flag (defined inpkg/constants/constants.go:722-725) has non-trivial effects on Copilot engine workflows, but is not documented anywhere indocs/.Behavior when
features.copilot-requests: true:COPILOT_GITHUB_TOKEN(copilot_engine_installation.go:33-34)GITHUB_TOKENasCOPILOT_GITHUB_TOKENinstead of a PAT (copilot_engine_execution.go:216-219)copilot-requests: writepermission into the workflow (tools.go:318-323)S2STOKENS=trueenvironment variable (copilot_engine_execution.go:244)Evidence that documentation was intended:
patch-add-copilot-requests-feature.mdexplicitly says it "documented thefeatures.copilot-requestsfeature flag"frontmatter.mdFeatures section only coversfeatures.action-modecopilot-requestsacross all ofdocs/yields zero relevant hitsImpact: Users who need token-free Copilot authentication via GitHub Actions OIDC/S2STOKENS cannot find the flag. The auth guide (
auth.mdx) only documents PAT-basedCOPILOT_GITHUB_TOKENsetup.Fix: Add a
#### Copilot Requests (features.copilot-requests)subsection to the Feature Flags section infrontmatter.md, explaining the four behavioral changes and when to use it.Persisting Issues
🟡 MEDIUM (persisting since strategy-30) —
status-commentschema description is stale after conflicting changesetsThe schema description for
on.status-comment(line 1603 inmain_workflow_schema.json) says:But
compiler_safe_outputs.go:192-195automatically setsStatusComment = trueforslash_commandandlabel_commandtriggers when not explicitly set, as introduced by theminor-enable-reaction-status-comment-by-default.mdchangeset:The schema description was written for the earlier
minor-decouple-status-comment.mdchangeset but was not updated when the default was re-enabled for command triggers.Impact: The schema description misleads users into thinking
status-commentis always opt-in, when it is actually opt-out for command-type triggers.Fix: Update the schema description to: "Whether to post status comments (started/completed) on the triggering item. Defaults to
trueforslash_commandandlabel_commandtriggers; must be explicitly set totruefor all other trigger types. Set tofalseto disable even for command triggers. Not bundled withai-reaction."Also update
frontmatter-full.md:820-825comment which has the same stale text.Schema Improvements Needed
on.status-commentmain_workflow_schema.json:1603Documentation Updates Required
set-issue-typesafe-outputs.md(ToC + section)frontmatter-full.md, schema$commentmark-pull-request-as-ready-for-reviewsafe-outputs.md(ToC + section),safe-outputs-pull-requests.mdfrontmatter-full.md,safe-outputs-specification.mdfeatures.copilot-requestsfrontmatter.mdfeatures section, all user docsconstants.go, 4+ workflow Go filesRecommendations
Add
set-issue-typesection tosafe-outputs.md— Add to the "Issues & Discussions" ToC entry and create a### Set Issue Typesection documenting theallowed,max,target,target-repo,allowed-repos, andstagedfields. This is a completed feature with no user-facing documentation.Add
mark-pull-request-as-ready-for-reviewsection tosafe-outputs.md— Add to the "Pull Requests" ToC entry and create a### Mark PR as Ready for Reviewsection. Documentrequired-labels,required-title-prefix,target,max, and cross-repo fields.Document
features.copilot-requestsin frontmatter.md — Add a subsection under Feature Flags describing the four behavioral changes this flag triggers, and cross-link with the Copilot authentication guide inauth.mdx.Fix
on.status-commentschema description — Update to accurately reflect auto-enablement for command triggers.Strategy Performance
safe-outputs.mdNext Steps
set-issue-typesection tosafe-outputs.md(ToC + documentation)mark-pull-request-as-ready-for-reviewsection tosafe-outputs.mdandsafe-outputs-pull-requests.mdfeatures.copilot-requestsin the Feature Flags section offrontmatter.mdon.status-commentschema description andfrontmatter-full.mdcommentReferences: §23473029442
Beta Was this translation helpful? Give feedback.
All reactions