Skip to main content

Module landing

Module landing 

Source
Expand description

The target-side landing model: file kinds, parameter rendering, and the routing block.

Every landable file has a declared kind — rendered files release-kit owns and may rewrite, seeded files the target tunes, state files the release automation maintains — and a rendered file’s bytes are a deterministic function of the payload plus the landing parameters, so a later command can compare what is on disk against what would be written. The kinds are declared here, beside the payload, never inferred at runtime; a test holds the table closed over every snippet.

Modules§

invariants
The invariants a seeded file still carries.
manifest
The landing record: .release-kit/manifest.json.

Structs§

Entry
One artifact of the payload projection: what would land at one destination, with the payload bytes it was rendered from.
Resolved
What one detection pass resolved for a target-side verb, with the override flags applied.

Enums§

Kind
Who owns a landed file’s bytes after landing.
Placement
How a projected artifact occupies its destination.

Constants§

AGENTS_DESTINATION
The destination the routing block splices into.
BLOCK_BEGIN
The block’s opening marker.
BLOCK_END
The block’s closing marker.
HOOKS_BEGIN
The hook block’s opening marker, a YAML comment at column zero.
HOOKS_DESTINATION
The destination the hook block splices into.
HOOKS_END
The hook block’s closing marker.
HOOK_TYPES_LINE
The top-level key the fresh hook file carries and the skills verify on an existing one: the commit-msg and pre-push hooks run only where their hook types are installed.
OWNER_TOKEN
The mechanical substitution sites in rendered files.
SCOPES_CSV_TOKEN
The scope list, comma-joined: hook arguments and prose.
SCOPES_PIPE_TOKEN
The scope list, pipe-joined: the title checks’ regular expression.

Functions§

block_markers
The markers of a block destination, or None for a whole-file one.
extract_block
The marked block inside a document, markers included, or None where the text carries no complete block.
hooks_block
The hook block template, markers included, without a trailing newline and with its scope token unrendered.
hooks_file_defect
The hook file’s defect, read from the target: None for a missing file or one the block can land in.
hooks_marker_defect
The one definition of an ill-formed hook file, shared by the splice and every reader that judges one.
hooks_splice_refusal
The refusal a landing verb answers before writing anything, where the target’s hook file offers the block no place.
kind_of
The declared kind of a destination, or None for a file the payload does not classify.
pair_files
The landable files of one (technology, forge) pair, as (destination, payload bytes).
parse_scopes
The --scopes argument parsed into the recorded list.
projection
The whole payload projection for one pair under the repo and scopes parameters: every snippet with its kind and rendered bytes, plus the routing block and the hook block, sorted by destination.
read_destination
The bytes an entry’s destination currently holds: the whole file, or the marked block extracted from the target’s AGENTS.md. None means the file — or the block — is absent.
read_recorded
The bytes a recorded destination currently holds, by the placement its name implies.
render
Substitute the landing parameters into a rendered file’s bytes.
repo_unresolved
The refusal a verb answers when it needs the repo parameter and neither a flag nor the remote supplies one.
resolve
Resolve forge and repository in one pass: the flags override, the origin remote answers otherwise.
routing_block
The routing block template, markers included, without a trailing newline and with its scope token unrendered.
splice_agents_block
The whole AGENTS.md content after splicing the rendered block.
splice_hooks_block
The whole .pre-commit-config.yaml content after splicing the rendered hook block.
write_destination
Land one entry: the whole file through the temp-plus-rename writer, or the block spliced into its document and the whole document rewritten the same way.