Struct Ctx 

pub struct Ctx {
    pub target: Utf8PathBuf,
    pub repo: String,
    pub forge: Option<Forge>,
    pub declared_forge: Option<String>,
    pub profile: ProfileSnapshot,
    pub capabilities: CapabilityRequests,
    pub host: Option<String>,
    pub required_check: Option<String>,
    pub required_workflow: Option<String>,
    pub cli: PathBuf,
    pub tech: Option<&'static str>,
    /* private fields */
}

One resolved run context.

Fields

target: Utf8PathBuf

The repository being set up.

repo: String

The project path on the forge, empty where the profile names none.

forge: Option<Forge>

The forge adapter the run acts through, where the profile names a forge this release drives. A target with no forge, or one this release has no adapter for, carries none: its local steps still run and its forge steps report as not applicable.

declared_forge: Option<String>

The forge the profile declares, preserved whatever the adapter says, so an unknown name stays readable.

profile: ProfileSnapshot

What the project is, as the target configuration resolves it.

capabilities: CapabilityRequests

Which optional products the target requests.

host: Option<String>

The remote host, where one was detected.

required_check: Option<String>

The value of --required-check, where given.

required_workflow: Option<String>

The committed setup.required_workflow, on GitHub alone. No flag answers it: the setup never writes it, it reads it to prove that the workflow the release gate waits on is the workflow that carries the check the gate judges.

cli: PathBuf

The resolved forge CLI binary.

tech: Option<&'static str>

The detected technology, where the version file names one.

Implementations

impl Ctx

pub fn resolve( target: &Utf8PathBuf, repo_flag: Option<&str>, forge_flag: Option<&str>, required_check: Option<&str>, ) -> Result<Self, RkError>

Resolve detection, overrides, and the forge CLI in one pass, before any step runs.

Errors

Refuses when the target is missing, when no remote resolves and no override covers the gap, when the host is unrecognized, and when the forge CLI is not on PATH.

pub fn require_cli(&mut self, steps: &[&StepSpec]) -> Result<(), RkError>

Resolve the forge CLI where this run will call the forge for one of steps, and refuse where it cannot be found.

The prerequisite belongs to the call, not to the command. A step is only a caller when the target’s configuration selects it, the target has not excluded it, and the step reaches the forge at this particular forge. A preview writes nothing, and asks anyway for the steps it would act on, because it names the command it would run and a CLI nothing could find is worth saying then.

Errors

Propagates the refusal when the forge CLI cannot be resolved.

SATISFIES forge-setup:applicability-follows-the-target-configuration

pub fn landed_destinations(&self) -> Option<&[String]>

The destinations the landing record names, or None where nothing landed here.

pub const fn has_adapter(&self) -> bool

Whether the run has a forge adapter to act through.

pub fn adapter(&self) -> Result<Forge, RkError>

The forge adapter, or the refusal a forge operation answers where the profile names no forge this release drives.

Errors

A prerequisite-unmet refusal naming the declared forge and the ones this release drives.

pub const fn automatic_release(&self) -> bool

Whether this target’s release is one release-kit drives.

pub fn driver(&self) -> Option<&str>

The release driver, where the profile names one.

pub fn declared_forge(&self) -> Option<&str>

The forge the profile declares, whatever the adapter says.

pub const fn reporting_policy(&self) -> bool

Whether the target requested the landed reporting policy.

pub fn trunk(&self) -> &str

The one permanent branch this run asserts.

pub fn line_prefix(&self) -> &str

The release-line prefix this run asserts.

pub fn retired_branches(&self) -> &[String]

The long-lived branches this run’s single-trunk step retires.

pub const fn release_lines(&self) -> bool

Whether a full apply runs the release-line protection.

pub fn excluded(&self, step: &str) -> Option<&str>

Why this target does not run the named step, where it declared an exclusion for it. The reason is what the report prints, so an excluded step is always visible with the answer behind it.

pub fn excluded_count(&self) -> usize

How many steps this target declared it does not run.

pub fn bot_app_id(&self) -> Option<&str>

The bot App’s public identifier this target states, where it does.

pub fn trunk_ruleset(&self) -> &str

The ruleset that protects the trunk.

pub fn safety_ruleset(&self) -> &str

The ruleset that keeps the trunk undeletable and unrewritable.

pub fn tag_ruleset(&self) -> &str

The ruleset that makes published tags immutable.

pub fn lines_ruleset(&self) -> &str

The ruleset that protects the release lines.

pub fn title_check(&self) -> &str

The context the landed title job reports under.

pub const fn integration(&self) -> Integration

Which authority carries an implementation onto this trunk.

pub const fn protection(&self) -> &Protection

The floored policy this target states, already judged at load.

pub fn self_hosted_gitlab(&self) -> bool

Whether this run targets a GitLab instance that is not gitlab.com, where registry trusted publishing cannot reach.

pub fn child_env(&self, step: &str) -> Vec<(OsString, OsString)>

The constructed environment a step receives. Secrets enter only for the step that consumes them; the caller records their handling.

pub fn secret_values() -> Vec<Zeroizing<Vec<u8>>>

The secret bytes a run must keep out of its own output: the values the environment carries. Every buffer is scrubbed on drop; none is ever logged or echoed.

Key material is not read here. The step that transmits a key adds the very bytes it sends, so the needle cannot describe one file while the child receives another.

Trait Implementations

impl Clone for Ctx

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ctx

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.