Skip to main content

Module setup

Module setup 

Source
Expand description

rk setup: execute the repository-side setup against the detected forge.

Preview is the default and is an offline rendering — it materializes nothing and invokes no external command. Apply runs each step as the observe-compare-apply-verify lifecycle: observe the current state, report and skip when satisfied, otherwise materialize the embedded script into the run’s private journal directory, verify its digest, spawn it as sh <path>, and read the state back. check calls the same observe functions with the mutating half unreachable from its code path.

Enums§

ForgeSnapshot
One destructive step’s forge snapshot, as the archive took it.

Functions§

destructive_steps
The destructive steps this target runs, offline: the steps whose before-state a migration must hold.
forge_snapshot_id
The registry id of a destructive step’s forge snapshot.
migration_snapshots
Take the before-state of every destructive step this target runs into snapshot, for a migration’s archive.
proof_word
Where the committed setup proof stands against this target, offline: absent, compatible, stale, or invalid.
run
Dispatch the setup surface.