Skip to content

docs(runner): list kernel_event.v1 in the schemas overview - #3405

Merged
Rul1an merged 1 commit into
mainfrom
claude/schemas-overview-kernel-v1
Oct 22, 2026
Merged

Rul1an merged 1 commit into
mainfrom
claude/schemas-overview-kernel-v1

Conversation

@Rul1an

@Rul1an Rul1an commented Oct 22, 2026

Copy link
Copy Markdown
Owner

The Active Contracts table in docs/reference/runner/schemas-overview.md still listed only assay.runner.kernel_event.v0. Since #3404 the runner writes assay.runner.kernel_event.v1, so this change:

  • adds a v1 row as the current archive contract, linking kernel-event-v1.schema.json;
  • keeps v0 as "retained for older archives", pointing to the operation_flags erratum in artifacts-v0.md. This follows the table's existing runtime_drift.v0 pattern.

Reported as a non-blocking note in the second-round review of #3404. Docs only; no code or schema file changes.

  • Head SHA: dd5d3329ce1ad7149b0bfcb233ccbd8ea602b1c5
  • Builder: Claude Code (claude/ branch). Review: pending, one non-building review is needed on this head.

🤖 Generated with Claude Code

The overview's Active Contracts table still named only kernel_event.v0.
The runner writes v1 since #3404; v0 stays listed for older archives,
with a pointer to its operation_flags erratum.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the area:docs Changes in docs label Oct 22, 2026
@coderabbitai

coderabbitai Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
📥 Commits

Reviewing files that changed from the base of the PR and between 5890622 and dd5d332.

📒 Files selected for processing: 1
  • docs/reference/runner/schemas-overview.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • Clarified that assay.runner.kernel_event.v1 is the current kernel-layer archive contract.
    • Marked kernel_event.v0 as retained for older archives and clarified the meaning of its exclusive label.

The runner schema overview adds assay.runner.kernel_event.v1 as the current kernel-layer NDJSON archive contract. It updates the kernel_event.v0 entry to describe its use in older archives and document the exclusive bit interpretation.

Changes: Runner schema reference

Layer / File(s) Summary
Kernel event schema entries
docs/reference/runner/schemas-overview.md
The table adds kernel_event.v1 for current runner kernel events. It retains kernel_event.v0 for older archives and documents the exclusive bit interpretation and erratum reference.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to dd5d3

No merge-blocking issue remains in the schema reference update.

Pre-merge checks: Passed 5
Check name Status Explanation
Description check Passed The description clearly explains the documentation change, including the addition of kernel_event.v1 and the retention and erratum reference for v0.
Title check Passed The title clearly identifies the documentation change and names kernel_event.v1 as the schema added to the runner schemas overview.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Rul1an

Rul1an commented Oct 22, 2026

Copy link
Copy Markdown
Owner Author

Non-building review of head dd5d3329ce1ad7149b0bfcb233ccbd8ea602b1c5 (parent 58906228aab4dd3db2e43c3b9c7b6bd52c905833, origin/main) in detached worktree /Users/roelschuurkes/wt-rev-3404. I did not build this change. The round-2 note on #3404 named this table; I did not author the governing spec or this diff.

Verdict: READY. The Active Contracts table on this head matches the current writer and the retained v0 mapping.

What the table says

docs/reference/runner/schemas-overview.md:30-31 is the whole diff (git diff dd5d3329ce1ad7149b0bfcb233ccbd8ea602b1c5^ dd5d3329ce1ad7149b0bfcb233ccbd8ea602b1c5: one file, two insertions, one deletion). git diff --check on that range was clean.

Line 30 adds assay.runner.kernel_event.v1 as archive contract, with sidecar schema/kernel-event-v1.schema.json. That file is on this head. Its schema const is assay.runner.kernel_event.v1 (kernel-event-v1.schema.json:19). The writer sets that string at crates/assay-runner-core/src/kernel.rs:225 from KERNEL_EVENT_SCHEMA_V1 (crates/assay-runner-schema/src/kernel_event.rs:15). A search of crates/ for schema:\s*KERNEL_EVENT_SCHEMA found that assignment and no other.

Line 31 keeps assay.runner.kernel_event.v0 as retained for older archives, with sidecar schema/kernel-event-v0.schema.json. That file is on this head. Its schema const is assay.runner.kernel_event.v0 (kernel-event-v0.schema.json:19). The scope cell says the exclusive label tests bit 0o400 (O_NOCTTY) and points at artifacts-v0.md. open_operation_flags (kernel_event.rs:90-92) pushes "exclusive" when flags & 0o400 != 0. The comment at kernel_event.rs:73-77 names that bit O_NOCTTY on Linux, and O_EXCL as 0o200. artifacts-v0.md:81-85 states the same mapping, and the link resolves to docs/reference/runner/artifacts-v0.md. The sidecar description at kernel-event-v0.schema.json:102 labels that mapping an erratum and repeats the same bit and the same Linux name.

Status labels and the rest of the page

archive contract is the status on the other archive rows (schemas-overview.md:27-29). retained for older archives follows retained for older reports on the historical runtime-drift row (schemas-overview.md:33): the current row keeps the contract status, and the older row says retained. No other Active Contracts row changes in the diff. The Version Notes section (schemas-overview.md:65-72) still talks only about runtime drift.

docs/reference/runner/index.md is outside the diff. Lines 36-37 already link both kernel schema files. A search of that file for kernel_event and kernel-event found those two links. It does not assign a currency the table now contradicts.

Drift

bash scripts/ci/check-docs-generated-drift.sh
generated artifacts reproduce from their generators (22 files).

scripts/docs/generate-crate-deps.sh inside that script runs cargo metadata --format-version=1 --no-deps. I did not run a crate build or cargo test. git status --porcelain was empty and git rev-parse HEAD stayed dd5d3329ce1ad7149b0bfcb233ccbd8ea602b1c5.

CI at this head

Required contexts from gh api repos/Rul1an/assay/branches/main/protection and .github/rulesets/main-required-ci-contexts.json: CI, host-capability-check, lane-check/proof, review-record-check.

@Rul1an

Rul1an commented Oct 22, 2026

Copy link
Copy Markdown
Owner Author
{
  "schema": "assay.review-record.v0",
  "head_sha": "dd5d3329ce1ad7149b0bfcb233ccbd8ea602b1c5",
  "builder": {"agent": "claude", "instance": "schemas-overview-kernel-v1"},
  "reviewer": {"agent": "cursor-grok", "instance": "review-3405-dd5d3329", "github_login": "Rul1an"},
  "review_completed": true,
  "verdict": "READY",
  "findings": [],
  "no_findings": true,
  "independence": {"did_not_build": true, "did_not_author_governing_spec": true}
}

@Rul1an
Rul1an merged commit 62f857e into main Oct 22, 2026
70 of 71 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Changes in docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants