[Schema Consistency] Schema Consistency Check - 2026-08-17 #53313
Closed
Replies: 1 comment
|
This discussion was automatically closed because it expired on 2026-08-18T05:36:53.419Z.
|
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.
🔍 Schema Consistency Check - 2026-08-17
Summary
Critical Issues
Top-level
github-appis implemented and documented but missing from the main schemapkg/parser/schemas/main_workflow_schema.jsonhas no top-levelgithub-appproperty.pkg/workflow/frontmatter_types.goincludesGitHubApp *GitHubAppConfig \json:"github-app,omitempty"`andpkg/workflow/workflow_github_app.goresolves it as a top-level fallback for activation, safe-outputs, checkout, andtools.github`.docs/src/content/docs/reference/frontmatter.mdcontains a dedicated### GitHub App (\github-app:`)` section.max-runsandmax-turnsexist in schema but are absent from typed frontmatter configfield_gaps.in_schema_not_frontmatter = ["max-runs", "max-turns"].pkg/workflow/engine.go(applyEngineTopLevelOverrides,buildTopLevelOnlyEngineConfig), so the feature exists behaviorally.pkg/workflow/frontmatter_types.goincludesMaxAICredits,MaxTurnCacheMisses,MaxDailyAICredits,MaxToolDenials, but no top-levelMaxRunsorMaxTurnsfields onFrontmatterConfig.Undocumented parser aliases under
user-rate-limitare accepted in code and used by workflowsRateLimitConfigusesmax-runs-per-windowinpkg/workflow/frontmatter_types.go.pkg/workflow/role_checks.goacceptsmax-runs-per-window, plus aliasesmax-runs, and legacymax..github/workflows/ai-moderator.mdand.github/workflows/auto-triage-issues.mduseuser-rate-limit.max:.Documentation Gaps
User-facing frontmatter guide omits
user-rate-limitentirelydocs/src/content/docs/reference/frontmatter.md: no matches foruser-rate-limitorignored-roles.pkg/workflow/frontmatter_types.goandpkg/workflow/role_checks.go.Generated full frontmatter reference omits
engine.extensionsdespite parser support and user-facing docspkg/workflow/engine.goparsesengine.extensions;pkg/workflow/pi_engine.gouses it for Pi extension installation.docs/src/content/docs/reference/frontmatter.mdhas### Engine Extensions (\engine.extensions:`)`.docs/src/content/docs/reference/frontmatter-full.mdhas noengine.extensionsmention.Schema Improvements Needed
github-apptopkg/parser/schemas/main_workflow_schema.json, aligned with the existing parser and docs.max-runsandmax-turnsshould be first-class typed frontmatter fields or removed from the schema if they are intentionally engine-only legacy shims.user-rate-limit.max/user-rate-limit.max-runsaliases in schema/docs or migrate workflows off aliases and deprecate them explicitly.Parser Updates Required
FrontmatterConfigfields for top-levelmax-runsandmax-turns, or centralize these fields exclusively in engine config and stop advertising them at top level.user-rate-limit.maxandmax-runsis intentional, emit a deprecation warning during parse so users can migrate toward the canonical schema form.Workflow Violations
.github/workflows/ai-moderator.mdusesuser-rate-limit.max: 5, which is parser-compatible but not schema-canonical..github/workflows/auto-triage-issues.mdusesuser-rate-limit.max:aliases, also parser-compatible but not schema-canonical.AWF Config-Source Drift Note
/tmp/gh-aw/agent/awf-config-drift.jsonreportsdegraded: true.Recommendations
github-appand reconciling top-levelmax-runs/max-turns.user-rate-limitindocs/src/content/docs/reference/frontmatter.md, including canonical keys and any deprecated aliases.max-runs-per-window) if alias support is meant to remain backward-compatible only.frontmatter-full.mdincludes nested fields likeengine.extensions.FrontmatterConfigand selected parser aliases.Strategy Performance
Next Steps
All reactions