Repository navigation
[Schema Consistency] Schema Consistency Check — 2026-11-02: three documentation contract mismatches #74042
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Schema Consistency Checker. A newer discussion is available at Discussion #74403. |
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-11-02
Three actionable inconsistencies found across documentation examples and accepted configuration. No critical runtime bug established. Analysis covered schema, parser/compiler, reference documentation, and repository workflow/shared frontmatter.
Key Findings
Retired GitHub repository alias remains documented (medium). cross-repository.md:70–88 advertises
tools.github.allowed-repos: currentand claims normalization to the current repository expression. The schema accepts onlyall,public,${{ github.repository }}, or arrays. The migration codemod explicitly replaces the legacy alias with the accepted expression. Impact: copying the documented example fails validation. Fix: replace the alias and remove the normalization claim; link the migration guidance.Dispatch examples omit the required workflow allowlist (medium). faq.md:185 shows only
max: 1; rate-limiting-controls.md:104 shows onlyenvironment: production. Both fragments fail schema validation. dispatch_workflow_validation.go:29 explicitly rejects an empty workflow list. Impact: users cannot compile either example as presented. Fix: addworkflows: [worker-name]to both examples and explain that the named worker must exist. Preserve the allowlist requirement.Reusable-worker example promises unsupported choice inputs (medium). safe-outputs.md:1543 declares
on.workflow_call.inputs.environment.type: choicewithoptionsand lists choice as supported. The workflow_call schema permits only string, number, and boolean, and disallows the options property. The generic input schema builder handles choice, but that does not make it valid in a workflow_call trigger. Impact: the documented Markdown worker fails schema validation. Fix: usetype: string, remove options, and describe validation in the worker. Any proposed choice extension needs explicit lowering to valid reusable-workflow inputs and tests.Evidence, exclusions, and analysis limits
Schema ↔ Parser
The precomputed top-level gaps are false positives:
docker-image-pull-policyis consumed through RawFrontmatter inpkg/workflow/docker.go:294, andwork-queue-policyis consumed inpkg/workflow/work_queue_policy.go:184. No corrective parser change is justified by those gaps.Validation Controls
currentrejected;${{ github.repository }}accepted.{max: 1}rejected;{max: 1, workflows: [worker]}accepted.{type: choice, options: [dev, production]}rejected;{type: string}accepted.Only static repository analysis and inert schema validation were performed. No workflow code was executed or dispatched. Existing cached findings were excluded from the new finding count. Source files were unchanged. References use main links and may move after this run.
AWF Canonical-Source Warning — Non-Authoritative
The supplied awf-config-drift.json reports degraded canonical-source retrieval. AWF config-source drift is therefore not established. This incomplete comparison must not drive a required-check failure, corrective PR, or drift issue.
Recommendations and Next Steps
Schema improvements / parser updates: none required for the conservative documentation fixes above. Workflow violations: none found for the selected patterns.
Strategy performance: 3 findings; high effectiveness; reuse recommended. Strategy cache updated with evidence and exclusions.
References: §41393769760
All reactions