Skip to main content

Module manifest

Module manifest 

Source
Expand description

The landing record: .release-kit/manifest.json.

The record is a manifest, not a stamp: rk status and rk upgrade make decisions from it, so it earns a parser that can fail and a stated schema version — an unknown shape refuses naming the record, never a best-effort read. It is written last, after every file has landed, through the temp-plus-rename writer, and it is committed: every reader it exists for sees only committed files, and it carries digests of committed files, nothing secret and nothing machine-specific.

Structs§

FileRecord
One landed destination.
Manifest
The record a landing writes and every target-side verb reads.
Parameters
The landing parameters, recorded whole.

Enums§

Alignment
How a record’s rk_version stands against this binary’s.
Workflow
The working-copy mode a landing records: a project decision, rendered into the landed blocks and changed only through the landing verbs.

Constants§

MANIFEST_PATH
Where the record lives, relative to the target root.
SCHEMA_VERSION
The schema this binary writes. It also reads schema 1 — the pre-mode record, whose absent workflow parameter reads as branches — and refuses anything else by name.

Functions§

alignment
Compare a record’s version against this binary’s.
load
Read the record at target, or None where no landing exists.
now
The current instant in the record’s RFC 3339 form.
version_is_newer
Whether candidate is ahead of pinned, by the same ordering the alignment uses.
write
Write the record, last, through the temp-plus-rename writer.