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.

Re-exports§

pub use manifest::Style;
pub use manifest::Workflow;

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.
Inputs
Explicit invocation answers; absence falls through to configuration.
Params
The complete input to a payload projection. Comparisons reconstruct it from the landing record; landing verbs resolve their candidate inputs.
Resolved
What one detection pass resolved for a target-side verb, with the override flags applied.
Withheld
One destination a landing withholds, with why.

Enums§

Kind
Who owns a landed file’s bytes after landing.
Placement
How a projected artifact occupies its destination.
Purpose
Compatibility policy for a landing candidate.

Constants§

AGENTS_DESTINATION
The destination the routing block splices into.
BLOCK_BEGIN
The block’s opening marker.
BLOCK_DESTINATIONS
Every block destination, in the order a landing writes them.
BLOCK_END
The block’s closing marker.
BRANCH_GRAMMAR
The one branch grammar.
GLOSSARY_DESTINATION
The destination the glossary block splices into.
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.
LINE_PREFIX_RE_TOKEN
The same prefix, escaped for a slash-delimited regular expression.
LINE_PREFIX_TOKEN
The release-line branch prefix, naming the lines a release trigger accepts beside the trunk.
NIX_DESTINATIONS
The destinations of the opt-in Nix capability, present in a projection only where the landing’s nix parameter is on.
NIX_WITHHOLDABLE
The subset a target with a flake of its own keeps out: the seed pair, whose files would sit beside a flake release-kit did not author.
OWNER_TOKEN
The mechanical substitution sites in rendered files.
REPO_PLACEHOLDER
The repository a preview stands in for where nothing answered.
REPO_TOKEN
The full recorded project path, including nested namespaces.
SCOPE_SHAPE
The one commit scope shape.
SCOPE_SHAPE_TOKEN
The one scope shape: the title checks’ regular expression.
SECURITY_SPANS
The three replaceable spans of a landed security policy, each as its ordered begin and end marker.
STYLE_TOKEN
The recorded release style: trunk arms the bot’s request in the landed release workflow, lines leaves every request unarmed.
TRUNK_BRANCH_TOKEN
The one permanent branch. A landed release trigger, ref guard, and branch guard each name it, so a target whose trunk is not master needs its own answer in its own bytes.

Functions§

block_markers
The markers of a block destination, or None for a whole-file one.
destinations
Every destination the payload can land, in declaration order.
extract_block
The marked block inside a document, markers included, or None where the text carries no complete block.
glossary_block
The glossary block, read from the bundle source carries.
hooks_block
The hook block for one workflow mode, read from the bundle source carries.
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.
nix_unsupported_shape
Why the whole Nix capability stays out of a landing, or None where the target’s crate shape supports the seed.
nix_withheld
Why the flake half of the Nix capability stays out of this landing, or None where the pair lands whole.
nix_withholding
The Nix destinations an opted-in landing withholds at this target, with the one reason, or None where the capability lands whole.
pair_files
The landable files of one (technology, forge) pair, as (destination, payload bytes), read from the bundle source carries.
projection
The whole payload projection for one pair, from the bundle source carries.
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 for one workflow mode: the whole of target-side governance, authored as blocks/agents-block.md.in and never grown into a method chapter, read from the bundle source carries.
scope_is_shaped
Whether one scope matches SCOPE_SHAPE.
splice_hooks_block
The whole .pre-commit-config.yaml content after splicing the rendered hook block.
splice_marked_block
The whole document’s bytes after splicing a marked block into it.
withhold_nix
Drop the Nix destinations this target cannot take from a projection, naming each with its reason.
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.