Skip to main content

Module landing

Module landing 

Source
Expand description

The target-side landing model: parameter resolution, what a target currently holds, and the direct 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 embedded sources 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 capability selection, and the Nix crate-shape judgment, have one implementation in crate::projection and are re-exported here under their old names. Params, the resolved input every projection takes, lives in crate::profile and is re-exported here. What lives in this file is the readers of a target’s recorded destinations and the submodules that lock, write, and record.

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::CODE_SCANNING_DESTINATIONS;
pub use crate::projection::CODE_SCANNING_TECHS;
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::SCORECARD_DESTINATIONS;
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::CheckoutMode;
pub use manifest::Integration;
pub use manifest::Provider;
pub use manifest::Style;
pub use crate::profile::Inputs;
pub use crate::profile::Params;
pub use crate::profile::Purpose;

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§

Resolved
What one detection pass resolved for a forge verb, with the override flags applied: a forge this binary drives, and the project path.
Withheld
One destination a landing withholds, with why.

Functions§

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 the forge and the repository a forge verb acts on, in one pass: the flags override, and the origin remote answers otherwise.