Skip to main content

Module landing

Module landing 

Source
Expand description

The target-side landing model on the release seam: parameter resolution, the seam-based projection, and the target writes.

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 pure pieces of that model, the kind table, the token rendering, the block templating, the splice and marker judgments, the pair selection, and the Nix crate-shape judgment, have one implementation in crate::projection and are re-exported here under their old names. What stays in this file is the path that reads a release bundle through the seam (projection over a ReleaseSource), which the planner and --to still need until a later phase deletes it, and the functions that read or write a target.

Re-exports§

pub use crate::projection::AGENTS_DESTINATION;
pub use crate::projection::BLOCK_BEGIN;
pub use crate::projection::BLOCK_DESTINATIONS;
pub use crate::projection::BLOCK_END;
pub use crate::projection::BRANCH_GRAMMAR;
pub use crate::projection::GLOSSARY_DESTINATION;
pub use crate::projection::HOOK_TYPES_LINE;
pub use crate::projection::HOOKS_BEGIN;
pub use crate::projection::HOOKS_DESTINATION;
pub use crate::projection::HOOKS_END;
pub use crate::projection::Kind;
pub use crate::projection::LINE_PREFIX_RE_TOKEN;
pub use crate::projection::LINE_PREFIX_TOKEN;
pub use crate::projection::NIX_DESTINATIONS;
pub use crate::projection::NIX_WITHHOLDABLE;
pub use crate::projection::OWNER_TOKEN;
pub use crate::projection::REPO_PLACEHOLDER;
pub use crate::projection::REPO_TOKEN;
pub use crate::projection::SCOPE_SHAPE;
pub use crate::projection::SCOPE_SHAPE_TOKEN;
pub use crate::projection::SECURITY_SPANS;
pub use crate::projection::STYLE_TOKEN;
pub use crate::projection::TRUNK_BRANCH_TOKEN;
pub use crate::projection::authored;
pub use crate::projection::block_markers;
pub use crate::projection::destinations;
pub use crate::projection::extract_block;
pub use crate::projection::hooks_marker_defect;
pub use crate::projection::kind_of;
pub use crate::projection::marker_defect;
pub use crate::projection::render;
pub use crate::projection::scope_is_shaped;
pub use crate::projection::splice_hooks_block;
pub use crate::projection::splice_marked_block;
pub use crate::projection::substitute;
pub use manifest::Style;
pub use manifest::Workflow;

Modules§

apply
The direct landing writer: from a computed Projection and the receipt as it stands to the files on disk and the receipt written last.
invariants
The invariants a seeded file still carries.
lock
One target held by one landing at a time.
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§

Placement
How a projected artifact occupies its destination.
Purpose
Compatibility policy for a landing candidate.

Functions§

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 and composed by pure::compose_hooks.
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_splice_refusal
The refusal a landing verb answers before writing anything, where the target’s hook file offers the block no place.
nix_unsupported_shape
Why the whole Nix capability stays out of a landing, or None where the target’s crate shape supports the seed: the crate shape read from target, judged by pure::nix_unsupported_shape.
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 and selected by pure::select_pair.
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.
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, read from the bundle source carries and composed by pure::compose_routing.
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.