Repository navigation
docs: read Rust's bench and fuzz reports from the runtime's reports branch - #88
Merged
Merged
Conversation
…ranch The runtime's CI now publishes rust.bench.json (every push to main) and rust.fuzz.json (nightly) on its unprotected `reports` branch, since main only takes pull requests. The sync script fetches them from there, and renders the fuzz report in a new `fuzz` section on the Rust page. Also picks up the conformance drift already on runtime and comline-typescript main (JSON-RPC case count, a new divergence class).
They change with every runtime push and nightly run, so committing them made the weekly drift check flag the pages almost every week. The Docs workflow now runs sync-language-support.py --render-reports before the build, writing docs/_generated/reports/ (ignored), which the pages include with pymdownx.snippets. A report that 404s, times out (10 s) or doesn't parse renders as "not published yet"; the build never fails on it. --check no longer covers those sections. The daily scheduled build picks up new numbers, and a repository_dispatch (reports-published) lets another repository ask for a rebuild. Branch rules: runtime's owned files are now all of .github/ and the accepted-regressions ledger.
Kinflou
force-pushed
the
docs/verification-report-sources
branch
from
October 25, 2026 19:56
26d1c2c to
7c5d00c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Points the language reference at where the Rust runtime now publishes its verification reports, and renders the benchmark and fuzzing results when the site builds instead of committing them. The runtime side is ComlineProject/runtime#48.
Runtime's
mainonly takes pull requests, so a workflow can't commit reports there. Runtime#48 has its CI commit them to an unprotectedreportsbranch instead:rust.bench.json, on every push tomain;rust.fuzz.json, from the nightly fuzz run.Rendered at build time
These results change with every runtime push and every nightly run. Committed, they would make the weekly drift check flag the pages almost every week. So they aren't committed:
docs.ymlrunsscripts/sync-language-support.py --render-reportsbeforezensical build --strict. It writesdocs/_generated/reports/<name>.{bench,fuzz}.md, which git ignores.pymdownx.snippets(--8<--). That covers Rust'sbenchandfuzzsections and TypeScript'sbenchsection. Zensical has no hook support, and themacrosplugin doesn't render under it (the CLI page shows its{{ row.flag }}raw), so a snippet include is the mechanism that works.::warning::on the run. The step also hastimeout-minutes: 2andcontinue-on-error: true. If the step doesn't run at all, the includes are empty, whichpymdownx.snippetsallows, and the build still passes.repository_dispatch(reports-published) so another repository can ask for a rebuild. Nothing sends that yet, because it needs a token that can write to this repository.--checkand the default sync no longer touch these sections. The support tables, runtime tables and divergences stay committed and drift-checked as before.Other changes
scripts/sync-language-support.py:(repo, rev, path). Rust's bench and fuzz reports are read fromruntime@reports.FUZZtable and--fuzz NAME=FILE, alongside--bench. Both work in--render-reportsmode.reference/languages/rust.md: the fuzz paragraph now introduces the rendered results, and both sections say they're fetched when the site is built.proposals/shared-runtime-core/verification.md: "What's left" no longer says the results are unpublished.conduct/branch-rules.md:reportsbranch..github/plus the accepted-regressions ledger, matching runtime#48's CODEOWNERS.docs/README.md: how to render the reports for a local build.main, in the committed tables.Testing
With the real CI reports from runtime#48's manual runs:
They render, and
zensical build --strictpasses. The strict build also passes with no_generated/at all.With GitHub refused (a dead proxy), the render exits 0 in about 0.1 s with warnings. An unroutable host gives up after the timeout. A malformed report renders as not published, with a warning.
--checkis clean.Until runtime#48 merges and publishes, the sections say "not published yet". The first push to runtime's
mainpublishes the bench report, and the next nightly publishes the fuzz report. The next docs build after that shows them.