2.0 KiB
2.0 KiB
Naming and contract migrations
This page tracks non-breaking renames and compatibility paths. Handbook, user manual, and reference docs should stay aligned when entries here change.
Boot hook API (ctx)
| Canonical (preferred) | Legacy alias | Notes |
|---|---|---|
bareOsRegisterBootStepHook(step, fn) |
bareOsRegisterBootPhaseHook(phase, fn) |
Same matching rules; step and phase are the same string keyspace. |
bareOsInvokeBootStepHooks(ev) |
bareOsInvokeBootPhaseHooks(ev) |
Event objects may include phase, step, and when; hooks match on phase / when:phase as before. |
bareOsEmitBareBootStepHint(payload) |
bareOsEmitBareBootPhaseHint(payload) |
Accepts step or phase in payload; host event name unchanged for listeners. |
Deprecation: legacy names remain supported; no removal date is set until downstream consumers migrate.
Boot policy JSON
| Canonical key(s) | Legacy alias(es) |
|---|---|
skipBootStages, denyBootStages |
skipPhases, denyBootPhases |
bootStagesRequireProcIndexMinSchema |
bootPhasesRequireProcIndexMinSchema |
bootStagesRequireLifecycleMinSchema |
bootPhasesRequireLifecycleMinSchema |
Merge logic accepts both names; first-party docs should cite canonical keys only.
Boot ready / journal payloads
bareOsPublishBootReadymay expose bothstages/phasesandbootStages/bootPhasesmirrors for consumers. Preferstages/bootStagesin new code.
Boot trace JSON (BARE_OS_BOOT_TRACE=json)
- Schema
bootTraceSchemaVersion: 2 adds canonicalstepalongsidestageand legacyphase(mirror). Parsers should preferstep.
CI gates
npm run pretestrunsbundle:kernel,verify-banned-terminology,verify-naming-alias-matrix,verify-feature-roadmap-canonical,verify-no-new-giant-phase-identifiers, compatibility matrix checks, and contract verifiers. ChangingbareOsCtxApiVersionor capability bits requires updating the linked scripts and docs listed in the rootpackage.jsonpretestchain.