Skip to main content

Module registry

Module registry 

Source
Expand description

The migration’s record: registry.yaml in the workspace.

Only the rk migrate verbs write it. Each source is one listed file with its checksum, its status, and its history; each group gathers the sources one predecessor mechanism spread across files and names the destinations that now carry what the project kept; each snapshot is a copy of what no Git holds. A status change appends a dated history entry and never rewrites an earlier one, so the registry is also the migration’s log.

Structs§

Group
The sources one mechanism spread across files, and where what the project kept now lives.
HistoryEntry
One dated status change.
Mark
What one mark names and asks.
Marked
What a mark changed: the sources it moved.
Registry
The whole registry.
Snapshot
A copy of what no Git holds, taken before anything destructive.
Source
One listed file.

Enums§

Integrity
What the file a snapshot names holds against its recorded checksum.
Status
Where one source stands.

Constants§

SCHEMA_VERSION
The registry shape this binary writes.

Functions§

assign_ids
Give every source a distinct id. In byte order of the paths, each source takes the slug of its path, or, where an earlier path took that slug, the slug with the first free -<n> counter from 2.
integrity
Read the file snapshot names under workspace against its checksum.
is_slug
Whether word is a lowercase slug, the shape of a group and a tag.
load
Read the registry of the workspace at workspace.
save
Write the registry atomically.
source_id
A source id: the path, lowercased, with every run of other characters turned into one hyphen.