Repository navigation
[Schema Consistency] 🔍 Schema Consistency Check - 2026-10-27 #72328
Closed
Replies: 1 comment
|
This discussion has been marked as outdated by Schema Consistency Checker. A newer discussion is available at Discussion #72587. |
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.
Overview
Found 3 actionable documentation inconsistencies by comparing schema constraints, compiler consumers, reference examples, and repository workflow usage. Used the cached Schema-def spot checks + targeted parser/doc/workflow verification strategy (day 300 modulo 10 = 0; proven-strategy selection). Previously cached findings were excluded.
Key Issues
cross-repository.md:73–88advertisestools.github.allowed-repos: current, including a claim that it is normalized. The schema enum accepts onlyall,public, and${{ github.repository }}as scalar values. A minimal configuration withcurrentfails; replacing it with${{ github.repository }}passes. Correct the example and normalization claim, or implement and validate the shorthand consistently.faq.md:185–193shows onlydispatch-workflow.max: 1. The object schema requiresworkflows, and the compiler explicitly reads that list. Addworkflows: [worker], identifying an existing workflow, so readers can compile the example.environmentunder the wrong key (medium).rate-limiting-controls.md:101–111placesenvironment: productionundersafe-outputs.dispatch-workflow. That object rejects the property, and its compiler config does not define a per-dispatch environment. Move it tosafe-outputs.environmentand supply the required dispatchworkflowslist. Explain that the environment gates the safe-outputs job.No critical runtime defect was established. These examples currently fail schema validation; the advertised approval configuration does not compile.
Evidence, validation, and scope
Schema ↔ Parser
The precomputed top-level gaps are false positives:
docker-image-pull-policyis consumed throughRawFrontmatterinpkg/workflow/docker.go:294, andwork-queue-policyinpkg/workflow/work_queue_policy.go:184. Do not add redundant fields solely to satisfy the enumeration heuristic.For finding 1, see schema enum and documentation example. A targeted compiler search found no corresponding GitHub guard normalization for the
currentliteral; the schema rejection alone establishes the documentation inconsistency.For finding 2, see FAQ example, dispatch schema, and compiler list extraction.
For finding 3, see approval example, dispatch configuration type, safe-outputs environment schema, and
pkg/workflow/safe_outputs_config_types.go:141.Validation
Reference YAML snippets were inspected with a YAML loader preserving
onas a key and normal Boolean values. Minimal inert configurations were checked using the local Draft7 schema withon: workflow_dispatch; this avoids treating missing context in documentation fragments as a defect. All three failing forms were reproduced and corrected controls passed schema validation. The environment counterexample included a validworkflowslist to isolate its unsupported nesting. No workflow code was executed or dispatched.Workflows
The supplied diff reports no top-level workflow keys missing from the schema. A targeted scan found dispatch usage in project workflows;
daily-report-dispatcher.md:22–24correctly supplies theworkflowslist. No new workflow violation was confirmed. This was not exhaustive nested validation of every workflow or imported template.Non-authoritative AWF Warning
The supplied AWF comparison has
degraded: true: canonical-source retrieval failed. Canonical AWF config-source consistency is therefore unassessed, not a confirmed drift finding. No corrective PR, drift issue, or required-check failure is proposed from this data. This warning is excluded from the inconsistency count.Recommendations and Next Steps
safe-outputs.environmentand document the job-level gate.No mandatory schema or parser changes are needed for the documentation-only corrections. No workflow-file fix was established. Source files were left unchanged.
Strategy Performance
Findings: 3 · Effectiveness: high for documentation contract checks · New strategy: no · Reuse: yes. Strategy results were saved to the strategy database.
References: §40455940762
All reactions