release_kit/landing/

manifest.rs

//! The landing record: `.release-kit/manifest.json`.
//!
//! The record is a manifest, not a stamp: `rk status` and `rk upgrade`
//! make decisions from it, so it earns a parser that can fail and a
//! stated schema version — an unknown shape refuses naming the record,
//! never a best-effort read. It is written last, after every file has
//! landed, through the temp-plus-rename writer, and it is committed:
//! every reader it exists for sees only committed files, and it carries
//! digests of committed files, nothing secret and nothing
//! machine-specific.

use std::collections::BTreeMap;

use camino::Utf8Path;
use serde::{Deserialize, Serialize};

use crate::atomic;
use crate::diagnostic::{Diagnostic, Reason};
use crate::digest::Digest;
use crate::error::RkError;
use crate::landing::Kind;
pub use crate::profile::{
    CapabilityRequests, GitWorkflow, ProfileSnapshot, ReleaseIntent, ReleaseMode,
};

/// Where the record lives, relative to the target root.
pub const MANIFEST_PATH: &str = ".release-kit/manifest.json";

/// The schema this binary writes.
///
/// Schema 10 is the receipt of a direct landing: the producing
/// `rk_version`, the origin, the resolved target configuration by domain,
/// and per destination the path, the kind, the placement where the
/// destination is a marked region, and the digest of the bytes or region
/// now present. It carries no bundle digest and no baseline digest,
/// because the landing renders afresh from this binary and compares
/// against no earlier release.
///
/// Schemas 1 through 8 read through one bounded conversion in
/// [`legacy`]: the retired `payload_sha256`, per-file `baseline_sha256`,
/// and `parameters.scopes` fields are dropped, the one technology becomes
/// the sole technology and the automatic release driver, and the flat
/// parameters move into their domains. The next successful landing
/// rewrites schema 10. Anything past this schema refuses by name.
///
/// Schema 10 adds `git.integration`, the authority that moves an
/// implementation onto the trunk. A record at schema 9 or below carries
/// no such key and reads as `forge`, which is the authority it landed.
///
/// Schema 11 adds `capabilities.workflow_guards`. A record at schema 10 or
/// below carries no such key: that is the pending answer, which reads as
/// kept, because every such landing carries the guards.
///
/// Schema 12 adds `git.merge_form`, how the commits of a branch reach the
/// trunk. A record at schema 11 or below carries no such key and reads as
/// `squash`, which is the form every such landing took.
///
/// SATISFIES landing:a-record-states-its-schema
/// SATISFIES git:the-merge-form-is-a-landing-parameter
pub const SCHEMA_VERSION: u64 = 12;

/// The oldest schema this binary still reads.
const OLDEST_READABLE_SCHEMA: u64 = 1;

/// The first schema that states a destination's placement. A record below
/// it carried none, and the block destinations were regions by their names
/// alone.
const PLACEMENT_SCHEMA: u64 = 7;

/// The checkout mode a landing records: where a topic branch opens.
///
/// A Git workflow parameter, rendered into the landed blocks and changed
/// only through the landing verbs. It selects a working tree and nothing
/// else: no branching method, no rebase policy, no merge policy.
///
/// SATISFIES git:checkout-mode-selects-where-a-topic-branch-opens
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum CheckoutMode {
    /// Every code-changing branch opens in a linked worktree and the main
    /// checkout commits nothing.
    LinkedWorktree,
    /// A branch opens in the repository's original working tree, which
    /// switches to it; worktrees stay available beside it and nothing
    /// refuses either form.
    MainWorktree,
}

impl CheckoutMode {
    /// The flag, wire, and report form.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::LinkedWorktree => "linked-worktree",
            Self::MainWorktree => "main-worktree",
        }
    }

    /// The label the runbooks select a variant on.
    #[must_use]
    pub const fn runbook_label(self) -> &'static str {
        match self {
            Self::LinkedWorktree => "worktree",
            Self::MainWorktree => "branches",
        }
    }

    /// Parse a `--checkout-mode` flag value. The two names a record
    /// carried before the vocabulary moved, `worktree` and `branches`,
    /// still read, so an older command line and an older configuration
    /// keep working.
    ///
    /// # Errors
    ///
    /// Returns [`RkError::Usage`] naming the two values.
    pub fn parse(raw: &str) -> Result<Self, RkError> {
        match raw {
            "linked-worktree" | "worktree" => Ok(Self::LinkedWorktree),
            "main-worktree" | "branches" => Ok(Self::MainWorktree),
            other => Err(RkError::Usage(format!(
                "unknown checkout mode '{other}'; the modes are: linked-worktree, main-worktree"
            ))),
        }
    }
}

impl<'de> serde::Deserialize<'de> for CheckoutMode {
    fn deserialize<D: serde::Deserializer<'de>>(reader: D) -> Result<Self, D::Error> {
        let raw = String::deserialize(reader)?;
        Self::parse(&raw).map_err(|error| serde::de::Error::custom(error.to_string()))
    }
}

/// The integration mode a landing records: which authority moves an
/// implementation onto the trunk.
///
/// A Git workflow parameter, rendered into the landed blocks and changed
/// only through the landing verbs. It selects an authority and nothing
/// else: no branching method, no checkout mode, and no release path.
///
/// SATISFIES git:integration-mode-selects-the-authority-that-squashes
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum Integration {
    /// The checkout performs and records the integration, through
    /// `rk integrate`, and the operator pushes the trunk separately.
    Local,
    /// The forge performs and records the integration, through a pull
    /// request or a merge request behind its required check.
    Forge,
}

impl Integration {
    /// The flag, wire, and report form.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Local => "local",
            Self::Forge => "forge",
        }
    }

    /// Parse an `--integration` flag value.
    ///
    /// # Errors
    ///
    /// Returns [`RkError::Usage`] naming the two values.
    pub fn parse(raw: &str) -> Result<Self, RkError> {
        match raw {
            "local" => Ok(Self::Local),
            "forge" => Ok(Self::Forge),
            other => Err(RkError::Usage(format!(
                "unknown integration mode '{other}'; the modes are: local, forge"
            ))),
        }
    }
}

impl<'de> serde::Deserialize<'de> for Integration {
    fn deserialize<D: serde::Deserializer<'de>>(reader: D) -> Result<Self, D::Error> {
        let raw = String::deserialize(reader)?;
        Self::parse(&raw).map_err(|error| serde::de::Error::custom(error.to_string()))
    }
}

/// The compatibility answer for a record written before the integration
/// axis existed: such a target landed the forge blocks and the forge
/// protections, so reading it as `local` would tell it that its trunk
/// takes direct pushes.
pub(crate) const fn integration_forge() -> Integration {
    Integration::Forge
}

/// The merge form a landing records: how the commits of a branch reach
/// the trunk.
///
/// A Git workflow parameter, changed only through the landing verbs. It
/// selects a form and nothing else: no authority, no checkout mode, and no
/// release path. Both forms keep the trunk linear and write no merge
/// commit.
///
/// SATISFIES git:the-merge-form-is-a-landing-parameter
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum MergeForm {
    /// The branch arrives as one commit, so one implementation is one
    /// trunk commit.
    Squash,
    /// The branch is rebased on the trunk tip and the trunk fast-forwards
    /// to it, so every commit arrives with its own message.
    Rebase,
}

impl MergeForm {
    /// The flag, wire, and report form.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Squash => "squash",
            Self::Rebase => "rebase",
        }
    }

    /// Parse a `--merge-form` flag value.
    ///
    /// # Errors
    ///
    /// Returns [`RkError::Usage`] naming the two values.
    pub fn parse(raw: &str) -> Result<Self, RkError> {
        match raw {
            "squash" => Ok(Self::Squash),
            "rebase" => Ok(Self::Rebase),
            other => Err(RkError::Usage(format!(
                "unknown merge form '{other}'; the forms are: squash, rebase"
            ))),
        }
    }
}

impl<'de> serde::Deserialize<'de> for MergeForm {
    fn deserialize<D: serde::Deserializer<'de>>(reader: D) -> Result<Self, D::Error> {
        let raw = String::deserialize(reader)?;
        Self::parse(&raw).map_err(|error| serde::de::Error::custom(error.to_string()))
    }
}

/// The compiled default, and the answer for a record written before the
/// merge form existed.
///
/// Every such landing took the squash form, so reading it as anything
/// else would change how its branches reach the trunk without a question.
#[must_use]
pub const fn merge_form_squash() -> MergeForm {
    MergeForm::Squash
}

/// The release style a landing records.
///
/// Whether the bot's release request stands armed to merge itself: a
/// project decision, rendered into the landed release workflow and
/// changed only through the landing verbs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Style {
    /// The trunk style: the release request carries auto-merge from
    /// creation, so a green trunk ships itself.
    Trunk,
    /// The lines style: every request waits for a human's merge, because
    /// a line's candidate is validated by hand.
    Lines,
}

impl Style {
    /// The flag, wire, and report form.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Trunk => "trunk",
            Self::Lines => "lines",
        }
    }

    /// Parse a `--style` flag value.
    ///
    /// # Errors
    ///
    /// Returns [`RkError::Usage`] naming the two values.
    pub fn parse(raw: &str) -> Result<Self, RkError> {
        match raw {
            "trunk" => Ok(Self::Trunk),
            "lines" => Ok(Self::Lines),
            other => Err(RkError::Usage(format!(
                "unknown style '{other}'; the styles are: trunk, lines"
            ))),
        }
    }
}

/// The code scanning provider a landing records.
///
/// A project decision: which analyzer the landed workflow runs, and with it
/// whether the landing carries a licence condition at all.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Provider {
    /// GitHub's own analyzer. Free under terms that cover an open-source
    /// codebase alone, so a landing reads the binding's declared licence
    /// first and refuses the pair where it states no such codebase.
    CodeQl,
    /// Semgrep Community Edition, which carries no licence condition on the
    /// codebase it scans and runs on either forge.
    Semgrep,
}

impl Provider {
    /// The flag, wire, and report form.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::CodeQl => "codeql",
            Self::Semgrep => "semgrep",
        }
    }

    /// Parse a `--code-scanning` flag value.
    ///
    /// # Errors
    ///
    /// Returns [`RkError::Usage`] naming the providers and the word that
    /// turns the capability off.
    pub fn parse(raw: &str) -> Result<Option<Self>, RkError> {
        match raw {
            "codeql" => Ok(Some(Self::CodeQl)),
            "semgrep" => Ok(Some(Self::Semgrep)),
            "off" => Ok(None),
            other => Err(RkError::Usage(format!(
                "unknown code scanning provider '{other}'; the providers are: codeql, semgrep, and off turns the capability off"
            ))),
        }
    }
}

/// The record a landing writes and every target-side verb reads.
///
/// Schema 9 records the resolved target configuration by domain: the
/// source-free profile snapshot, the Git workflow parameters, the
/// capability requests, and the render parameters no domain owns.
#[derive(Debug, Serialize, Deserialize)]
pub struct Manifest {
    /// An integer this binary either knows or refuses on.
    pub schema_version: u64,
    /// The binary that produced the landing.
    pub rk_version: String,
    /// `init` or `adopt` — how the record came to exist.
    pub origin: String,
    /// When the first landing happened; an upgrade preserves it.
    pub landed_at: String,
    /// What the project is: its technologies, its forge where it has one,
    /// and its release intent. Values alone, no precedence source.
    pub profile: ProfileSnapshot,
    /// How topic branches reach the trunk: the trunk's name and the
    /// checkout mode.
    pub git: GitWorkflow,
    /// Which optional products the target requested.
    pub capabilities: CapabilityRequests,
    /// Every remaining value substituted into a `rendered` file, so a
    /// re-render is reproducible without asking again.
    pub parameters: Parameters,
    /// Every landed destination with its kind and digests.
    pub files: Vec<FileRecord>,
    /// The registry pins the selected capabilities use, copied at landing
    /// time; `rk status` compares them offline.
    pub pins: BTreeMap<String, String>,
}

/// The render parameters no domain table owns, recorded whole.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Parameters {
    /// The project path on the forge, recorded whole because a GitLab
    /// project may nest below its group. Empty where the target has no
    /// forge repository.
    #[serde(default)]
    pub repo: String,
    /// The contact the landed policy names where the forge's own channel
    /// is unavailable, empty for the forge's authored wording. A record
    /// predating the field reads as empty, which is what such a landing
    /// wrote.
    #[serde(default, deserialize_with = "read_contact")]
    pub security_contact: String,
    /// The acknowledgment window the landed policy promises. A record
    /// predating the field reads as `best-effort`, which is what such a
    /// landing wrote.
    #[serde(default = "response_best_effort", deserialize_with = "read_response")]
    pub security_response: String,
    /// The check the release gate believes. A record predating the field
    /// reads as empty, which is what such a landing wrote: it rendered a
    /// standing arm that named no check.
    #[serde(default)]
    pub required_check: String,
    /// The workflow whose completion wakes the release gate. A record
    /// predating the field reads as empty, for the same reason.
    #[serde(default)]
    pub required_workflow: String,
    /// How a command runs in the project's own development environment,
    /// absent where the project gives no answer. A record predating the
    /// field reads as absent, which is what such a landing rendered, and a
    /// record with no answer omits the key, so its bytes do not change.
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        deserialize_with = "read_dev_environment"
    )]
    pub dev_environment: Option<crate::config::dev_environment::DevEnvironment>,
}

/// A recorded development environment, held to the configuration's own
/// rules, because the record is the one input a re-render reads.
fn read_dev_environment<'de, D: serde::Deserializer<'de>>(
    reader: D,
) -> Result<Option<crate::config::dev_environment::DevEnvironment>, D::Error> {
    let answer = crate::config::dev_environment::DevEnvironment::deserialize(reader)?;
    answer.check().map_err(|reason| {
        serde::de::Error::custom(format!("parameters.dev_environment: {reason}"))
    })?;
    answer.answered().map_or_else(
        || {
            Err(serde::de::Error::custom(
                "parameters.dev_environment: a recorded answer names a run prefix",
            ))
        },
        |answer| Ok(Some(answer)),
    )
}

/// The stance a record predating the field carries.
fn response_best_effort() -> String {
    crate::config::RESPONSE_DEFAULT.to_owned()
}

/// A recorded contact, refused where the configuration reader would refuse
/// it or where it is not already canonical.
///
/// The record is the one input a re-render reads, so a hand-edited record
/// must not reach bytes the configured path could never have produced.
fn read_contact<'de, D: serde::Deserializer<'de>>(reader: D) -> Result<String, D::Error> {
    canonical(reader, "security_contact", crate::config::canonical_contact)
}

/// A recorded response stance, held to the same grammar as the key.
fn read_response<'de, D: serde::Deserializer<'de>>(reader: D) -> Result<String, D::Error> {
    canonical(
        reader,
        "security_response",
        crate::config::canonical_response,
    )
}

/// One recorded string held to its canonical form.
fn canonical<'de, D: serde::Deserializer<'de>>(
    reader: D,
    field: &str,
    judge: impl Fn(&str) -> Result<String, String>,
) -> Result<String, D::Error> {
    let raw = String::deserialize(reader)?;
    let canonical = judge(&raw)
        .map_err(|reason| serde::de::Error::custom(format!("parameters.{field}: {reason}")))?;
    if canonical == raw {
        Ok(canonical)
    } else {
        Err(serde::de::Error::custom(format!(
            "parameters.{field} is not canonical: the record carries {raw:?} where a landing writes {canonical:?}"
        )))
    }
}

/// One landed destination.
#[derive(Debug, Serialize, Deserialize)]
pub struct FileRecord {
    /// The destination, relative to the target root.
    pub destination: String,
    /// The declared ownership kind.
    pub kind: Kind,
    /// The digest of what the destination holds: the bytes now present
    /// for a whole file, the marked region alone for a region destination.
    pub sha256: Digest,
    /// How the landing occupies the destination: the whole file, which
    /// the record omits, or one marked region inside a document the
    /// target owns.
    #[serde(default, skip_serializing_if = "Placement::is_whole")]
    pub placement: Placement,
}

/// How a recorded destination is occupied.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Placement {
    /// The landing owns the whole file.
    #[default]
    Whole,
    /// The landing owns the one marked region; every byte outside it is
    /// the target's.
    Region,
}

impl Placement {
    /// Whether this is the default the record omits.
    #[must_use]
    pub const fn is_whole(&self) -> bool {
        matches!(self, Self::Whole)
    }

    /// The report form.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Whole => "whole",
            Self::Region => "region",
        }
    }
}

/// The one bounded conversion from a record at schemas 1 through 8 to the
/// current shape.
///
/// It reads no other release and interprets no other release's sources:
/// it drops the fields the direct landing retired, and it moves the one
/// technology, the forge, and the flat parameters an older record carried
/// into the domains schema 9 states. Every older record described an
/// automatic release driven by its one technology, with the reporting
/// policy landed, so that is what the conversion says.
pub mod legacy {
    use serde_json::{Map, Value, json};

    /// Take a field out of a JSON object, where it is one.
    fn take(object: &mut Map<String, Value>, key: &str) -> Option<Value> {
        object.remove(key)
    }

    /// Rewrite a record value at a schema before this binary's so it
    /// deserializes as the current shape.
    ///
    /// `payload_sha256` named a bundle digest no comparison reads any
    /// more; per-file `baseline_sha256` fed a three-way comparison that
    /// no longer exists; `parameters.scopes` was a vocabulary this binary
    /// renders nowhere. `tech`, `forge`, and the flat `parameters` become
    /// the `profile`, `git`, and `capabilities` domains, with the old
    /// `worktree` and `branches` mode names read as `linked-worktree` and
    /// `main-worktree`.
    #[must_use]
    pub fn convert(mut value: Value) -> Value {
        let Some(record) = value.as_object_mut() else {
            return value;
        };
        record.remove("payload_sha256");
        if let Some(files) = record.get_mut("files").and_then(Value::as_array_mut) {
            for file in files.iter_mut().filter_map(Value::as_object_mut) {
                file.remove("baseline_sha256");
            }
        }
        if record.contains_key("profile") {
            return value;
        }
        let tech = take(record, "tech").and_then(|v| v.as_str().map(str::to_owned));
        let forge = take(record, "forge").and_then(|v| v.as_str().map(str::to_owned));
        let mut parameters = take(record, "parameters")
            .and_then(|v| v.as_object().cloned())
            .unwrap_or_default();
        parameters.remove("scopes");
        let checkout_mode = match parameters
            .remove("workflow")
            .and_then(|v| v.as_str().map(str::to_owned))
            .as_deref()
        {
            Some("worktree") => "linked-worktree",
            // A record predating the mode carried none, and such a
            // landing wrote the blocks without the guard.
            _ => "main-worktree",
        };
        let style = parameters.remove("style").unwrap_or(Value::Null);
        let trunk = parameters
            .remove("trunk")
            .unwrap_or_else(|| json!(crate::config::TRUNK_DEFAULT));
        let line_prefix = parameters
            .remove("line_prefix")
            .unwrap_or_else(|| json!(crate::config::LINE_PREFIX_DEFAULT));
        let nix = parameters.remove("nix").unwrap_or(json!(false));
        let scorecard = parameters.remove("scorecard").unwrap_or(json!(false));
        let code_scanning = parameters.remove("code_scanning").unwrap_or(Value::Null);
        let mut release = Map::new();
        release.insert("mode".into(), json!("automatic"));
        if let Some(tech) = &tech {
            release.insert("driver".into(), json!(tech));
        }
        if !style.is_null() {
            release.insert("style".into(), style);
        }
        release.insert("line_prefix".into(), line_prefix);
        let technologies: Vec<Value> = tech.iter().map(|t| json!(t)).collect();
        record.insert(
            "profile".into(),
            json!({
                "technologies": technologies,
                "forge": forge,
                "release": Value::Object(release),
            }),
        );
        record.insert(
            "git".into(),
            json!({ "trunk": trunk, "checkout_mode": checkout_mode }),
        );
        record.insert(
            "capabilities".into(),
            json!({
                "nix_packaging": nix,
                "reporting_policy": true,
                "scorecard": scorecard,
                "code_scanning": code_scanning,
            }),
        );
        record.insert("parameters".into(), Value::Object(parameters));
        value
    }
}

impl Manifest {
    /// The recorded entry for one destination, where the record names it.
    #[must_use]
    pub fn file(&self, destination: &str) -> Option<&FileRecord> {
        self.files
            .iter()
            .find(|file| file.destination == destination)
    }
}

/// Read the record at `target`, or `None` where no landing exists.
///
/// # Errors
///
/// The record's stated failure taxonomy: an unreadable record is a
/// refusal naming it, a record at an unknown `schema_version` is a
/// refusal naming the record, and one that does not parse at a known
/// schema is a defect-class failure.
pub fn load(target: &Utf8Path) -> Result<Option<Manifest>, RkError> {
    let path = target.join(MANIFEST_PATH);
    let bytes = match std::fs::read(&path) {
        Ok(bytes) => bytes,
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
        Err(e) => {
            return Err(RkError::refusal(
                Diagnostic::new(Reason::Io, format!("cannot read {path}: {e}"))
                    .expected("a readable landing record")
                    .target_state("unchanged"),
            ));
        }
    };
    let value: serde_json::Value = serde_json::from_slice(&bytes)
        .map_err(|e| record_invalid(&path, &format!("{path} is not a landing record: {e}")))?;
    // A record at an earlier schema converts through the one legacy
    // conversion. Anything past this binary's schema refuses by the
    // record schema alone: the record decides whether a guard is landed,
    // and an older binary must never silently ignore that.
    let schema = value
        .get("schema_version")
        .and_then(serde_json::Value::as_u64);
    if !schema.is_some_and(|version| (OLDEST_READABLE_SCHEMA..=SCHEMA_VERSION).contains(&version)) {
        let found = schema.map_or_else(|| "none".to_owned(), |version| version.to_string());
        return Err(RkError::refusal(
            Diagnostic::new(
                Reason::UnsupportedSchema,
                format!(
                    "{path} declares schema_version {found}, and this binary knows only {OLDEST_READABLE_SCHEMA} through {SCHEMA_VERSION}"
                ),
            )
            .expected("a landing record at a schema this binary knows")
            .action("install the rk release that wrote this record, or a newer one")
            .target_state("unchanged"),
        ));
    }
    let declared = schema.unwrap_or(SCHEMA_VERSION);
    let value = if declared < SCHEMA_VERSION {
        legacy::convert(value)
    } else {
        value
    };
    let mut manifest: Manifest = serde_json::from_value(value).map_err(|e| {
        record_invalid(
            &path,
            &format!("{path} does not parse at schema_version {declared}: {e}"),
        )
    })?;
    // A record below the placement schema stated none: the block
    // destinations were regions by their names alone, and the loaded shape
    // says so.
    for file in &mut manifest.files {
        if declared < PLACEMENT_SCHEMA && crate::landing::block_markers(&file.destination).is_some()
        {
            file.placement = Placement::Region;
        }
    }
    Ok(Some(manifest))
}

/// The refusal a record that exists and does not parse answers with.
///
/// It is the target's file that is wrong, not this binary, so it carries
/// the same parts a `config-invalid` refusal does: what to change, and
/// that nothing was written. Git usually holds the last good copy, which
/// is why the action names the restore first.
fn record_invalid(path: &Utf8Path, message: &str) -> RkError {
    RkError::refusal(
        Diagnostic::new(Reason::RecordInvalid, message)
            .expected("a landing record this binary wrote, or one it can convert")
            .action(format!(
                "restore {path} from Git, or repair the file it names, and retry"
            ))
            .target_state("nothing was written"),
    )
}

/// Write the record, last, through the temp-plus-rename writer.
///
/// # Errors
///
/// Any write failure; the destination then holds what it held.
pub fn write(target: &Utf8Path, manifest: &Manifest) -> Result<(), RkError> {
    let path = target.join(MANIFEST_PATH);
    atomic::write(path.as_std_path(), &render(manifest)?)?;
    Ok(())
}

/// The bytes [`write`] puts on disk for a record.
///
/// # Errors
///
/// A serialization failure, which is a defect in this binary.
pub fn render(manifest: &Manifest) -> Result<Vec<u8>, RkError> {
    let text = serde_json::to_string_pretty(manifest).map_err(anyhow::Error::from)?;
    Ok(format!("{text}\n").into_bytes())
}

/// The current instant in the record's RFC 3339 form.
#[must_use]
pub fn now() -> String {
    humantime::format_rfc3339_seconds(std::time::SystemTime::now()).to_string()
}

/// How a record's `rk_version` stands against this binary's.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum Alignment {
    /// The landing came from this binary's version.
    Aligned,
    /// The binary is newer; `rk upgrade` takes the target forward.
    BinaryNewer,
    /// The landing came from a newer `rk` than this one, which an upgrade
    /// refuses rather than downgrading.
    TargetNewer,
}

impl Alignment {
    /// The wire form, identical to the serde rendering.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::Aligned => "aligned",
            Self::BinaryNewer => "binary-newer",
            Self::TargetNewer => "target-newer",
        }
    }
}

/// Compare a record's version against this binary's.
#[must_use]
pub fn alignment(recorded: &str, binary: &str) -> Alignment {
    // Build metadata after `+` carries no precedence.
    let recorded = recorded
        .split_once('+')
        .map_or(recorded, |(version, _)| version);
    let binary = binary
        .split_once('+')
        .map_or(binary, |(version, _)| version);
    let recorded_core = numeric_core(recorded);
    let binary_core = numeric_core(binary);
    match binary_core.cmp(&recorded_core) {
        std::cmp::Ordering::Greater => Alignment::BinaryNewer,
        std::cmp::Ordering::Less => Alignment::TargetNewer,
        std::cmp::Ordering::Equal => {
            // Equal numeric cores: a pre-release is older than the plain
            // release it precedes, and two pre-releases compare by semver
            // precedence — dot-separated identifiers, numeric ones
            // numerically and below alphanumeric ones.
            let recorded_pre = recorded.split_once('-').map(|(_, pre)| pre);
            let binary_pre = binary.split_once('-').map(|(_, pre)| pre);
            match (recorded_pre, binary_pre) {
                (Some(_), None) => Alignment::BinaryNewer,
                (None, Some(_)) => Alignment::TargetNewer,
                (None, None) => Alignment::Aligned,
                (Some(r), Some(b)) => match prerelease_cmp(b, r) {
                    std::cmp::Ordering::Greater => Alignment::BinaryNewer,
                    std::cmp::Ordering::Less => Alignment::TargetNewer,
                    std::cmp::Ordering::Equal => Alignment::Aligned,
                },
            }
        }
    }
}

/// Whether `candidate` is ahead of `pinned`, by the same ordering the
/// alignment uses.
#[must_use]
pub fn version_is_newer(candidate: &str, pinned: &str) -> bool {
    alignment(pinned, candidate) == Alignment::BinaryNewer
}

/// Semver pre-release precedence: identifier by identifier, numeric ones
/// numerically and below any alphanumeric one, and — all preceding
/// identifiers equal — the longer list wins. An all-digit identifier
/// compares by digit count and then lexically, which is numeric order at
/// any length — semver forbids leading zeroes — so no integer parse can
/// overflow into a wrong answer.
fn prerelease_cmp(a: &str, b: &str) -> std::cmp::Ordering {
    let numeric = |identifier: &str| identifier.bytes().all(|byte| byte.is_ascii_digit());
    let mut left = a.split('.');
    let mut right = b.split('.');
    loop {
        match (left.next(), right.next()) {
            (None, None) => return std::cmp::Ordering::Equal,
            (None, Some(_)) => return std::cmp::Ordering::Less,
            (Some(_), None) => return std::cmp::Ordering::Greater,
            (Some(x), Some(y)) => {
                let ordering = match (numeric(x), numeric(y)) {
                    (true, true) => x.len().cmp(&y.len()).then_with(|| x.cmp(y)),
                    (true, false) => std::cmp::Ordering::Less,
                    (false, true) => std::cmp::Ordering::Greater,
                    (false, false) => x.cmp(y),
                };
                if ordering != std::cmp::Ordering::Equal {
                    return ordering;
                }
            }
        }
    }
}

/// The dotted numeric components before any pre-release suffix.
fn numeric_core(version: &str) -> Vec<u64> {
    let core = version.split_once('-').map_or(version, |(core, _)| core);
    core.split('.')
        .map(|part| part.parse::<u64>().unwrap_or(0))
        .collect()
}

#[cfg(test)]
mod tests {
    use super::{
        Alignment, CapabilityRequests, CheckoutMode, FileRecord, GitWorkflow, Manifest, Parameters,
        Placement, ProfileSnapshot, Provider, ReleaseIntent, ReleaseMode, Style, alignment,
    };
    use crate::digest::Digest;
    use crate::landing::Integration;
    use crate::landing::Kind;

    /// The complete record shape at schema 9, held by snapshot: a field
    /// rename or removal fails here and becomes a schema-version bump
    /// instead of a silent break at every reader.
    #[test]
    fn the_manifest_schema_snapshot_holds() {
        let manifest = Manifest {
            schema_version: super::SCHEMA_VERSION,
            rk_version: "0.1.0".into(),
            origin: "init".into(),
            landed_at: "2026-08-29T00:00:00Z".into(),
            profile: ProfileSnapshot {
                technologies: vec!["rust".into()],
                forge: Some("github".into()),
                release: ReleaseIntent {
                    mode: ReleaseMode::Automatic,
                    driver: Some("rust".into()),
                    style: Some(Style::Trunk),
                    line_prefix: Some(crate::config::LINE_PREFIX_DEFAULT.to_owned()),
                },
            },
            git: GitWorkflow {
                trunk: crate::config::TRUNK_DEFAULT.to_owned(),
                checkout_mode: CheckoutMode::LinkedWorktree,
                integration: Integration::Local,
                merge_form: crate::landing::MergeForm::Squash,
            },
            capabilities: CapabilityRequests {
                nix_packaging: true,
                reporting_policy: true,
                scorecard: true,
                code_scanning: Some(Provider::Semgrep),
                workflow_guards: Some(false),
            },
            parameters: Parameters {
                repo: "acme/widget".into(),
                security_contact: String::new(),
                security_response: crate::config::RESPONSE_DEFAULT.to_owned(),
                required_check: String::new(),
                required_workflow: String::new(),
                dev_environment: None,
            },
            files: vec![
                FileRecord {
                    destination: "release-plz.toml".into(),
                    kind: Kind::Seeded,
                    sha256: Digest::of(b""),
                    placement: Placement::Whole,
                },
                FileRecord {
                    destination: "AGENTS.md".into(),
                    kind: Kind::Rendered,
                    sha256: Digest::of(b""),
                    placement: Placement::Region,
                },
            ],
            pins: std::iter::once(("release-plz".to_owned(), "0.3.160".to_owned())).collect(),
        };
        let empty = Digest::of(b"").to_string();
        let text = serde_json::to_string(&manifest).expect("a manifest serializes");
        assert_eq!(
            text,
            format!(
                r#"{{"schema_version":12,"rk_version":"0.1.0","origin":"init","landed_at":"2026-08-29T00:00:00Z","profile":{{"technologies":["rust"],"forge":"github","release":{{"mode":"automatic","driver":"rust","style":"trunk","line_prefix":"release/"}}}},"git":{{"trunk":"master","checkout_mode":"linked-worktree","integration":"local","merge_form":"squash"}},"capabilities":{{"nix_packaging":true,"reporting_policy":true,"scorecard":true,"code_scanning":"semgrep","workflow_guards":false}},"parameters":{{"repo":"acme/widget","security_contact":"","security_response":"best-effort","required_check":"","required_workflow":""}},"files":[{{"destination":"release-plz.toml","kind":"seeded","sha256":"{empty}"}},{{"destination":"AGENTS.md","kind":"rendered","sha256":"{empty}","placement":"region"}}],"pins":{{"release-plz":"0.3.160"}}}}"#
            ),
            "a whole file omits its placement, and no retired digest field survives"
        );
        assert!(!text.contains("payload_sha256") && !text.contains("baseline_sha256"));
        // A release-less record omits the automatic-only keys and the forge.
        let release_less = Manifest {
            profile: ProfileSnapshot {
                technologies: vec![],
                forge: None,
                release: ReleaseIntent {
                    mode: ReleaseMode::None,
                    driver: None,
                    style: None,
                    line_prefix: None,
                },
            },
            capabilities: CapabilityRequests {
                nix_packaging: false,
                reporting_policy: false,
                scorecard: false,
                code_scanning: None,
                workflow_guards: Some(false),
            },
            parameters: Parameters {
                repo: String::new(),
                security_contact: String::new(),
                security_response: crate::config::RESPONSE_DEFAULT.to_owned(),
                required_check: String::new(),
                dev_environment: None,
                required_workflow: String::new(),
            },
            files: vec![],
            pins: std::collections::BTreeMap::new(),
            ..manifest
        };
        assert_eq!(
            serde_json::to_string(&release_less).expect("serializes"),
            r#"{"schema_version":12,"rk_version":"0.1.0","origin":"init","landed_at":"2026-08-29T00:00:00Z","profile":{"technologies":[],"release":{"mode":"none"}},"git":{"trunk":"master","checkout_mode":"linked-worktree","integration":"local","merge_form":"squash"},"capabilities":{"nix_packaging":false,"reporting_policy":false,"scorecard":false,"workflow_guards":false},"parameters":{"repo":"","security_contact":"","security_response":"best-effort","required_check":"","required_workflow":""},"files":[],"pins":{}}"#
        );
    }

    /// A record written before the domains existed reads as an automatic
    /// release driven by its one technology, in the main-worktree mode,
    /// with the reporting policy it landed, and its scope vocabulary
    /// drops, because this binary renders none. Every earlier schema
    /// converts through the one legacy path with its retired digests
    /// ignored, and a record past this binary's schema refuses by the
    /// record schema alone, naming no other schema.
    #[test]
    fn a_schema_1_record_reads_as_branches_and_a_newer_schema_refuses() {
        let dir = tempfile::tempdir().expect("a scratch target exists");
        let target = camino::Utf8Path::from_path(dir.path()).expect("utf-8 path");
        std::fs::create_dir_all(target.join(".release-kit")).expect("the record dir writes");
        let record = |schema: u64| {
            format!(
                r#"{{"schema_version":{schema},"rk_version":"0.1.0","payload_sha256":"0000000000000000000000000000000000000000000000000000000000000000","origin":"init","tech":"rust","forge":"github","landed_at":"2026-08-29T00:00:00Z","parameters":{{"repo":"acme/widget","scopes":["api"]}},"files":[],"pins":{{}}}}"#
            )
        };
        std::fs::write(target.join(super::MANIFEST_PATH), record(1)).expect("the record writes");
        let manifest = super::load(target)
            .expect("a schema-1 record loads")
            .expect("the record exists");
        assert_eq!(manifest.git.checkout_mode, CheckoutMode::MainWorktree);
        assert_eq!(manifest.profile.technologies, vec!["rust".to_owned()]);
        assert_eq!(manifest.profile.forge.as_deref(), Some("github"));
        assert_eq!(manifest.profile.release.mode, ReleaseMode::Automatic);
        assert_eq!(manifest.profile.release.driver.as_deref(), Some("rust"));
        assert_eq!(
            manifest.profile.release.style, None,
            "a pre-style record carries no style; the upgrade demands one"
        );
        assert_eq!(
            manifest.profile.release.line_prefix.as_deref(),
            Some(crate::config::LINE_PREFIX_DEFAULT)
        );
        assert_eq!(manifest.git.trunk, crate::config::TRUNK_DEFAULT);
        assert!(
            !manifest.capabilities.nix_packaging,
            "a pre-nix record reads as opt-out, so an upgrade adds nothing unrequested"
        );
        assert!(
            manifest.capabilities.reporting_policy,
            "an older landing carried the policy, so the record says so"
        );
        assert_eq!(
            manifest.parameters.security_contact, "",
            "a pre-policy record names no contact, which is what its policy landed"
        );
        assert_eq!(
            manifest.parameters.security_response,
            crate::config::RESPONSE_DEFAULT,
            "a pre-policy record promises no window, which is what its policy landed"
        );

        for schema in 2..=8 {
            std::fs::write(
                target.join(super::MANIFEST_PATH),
                format!(
                    r#"{{"schema_version":{schema},"rk_version":"0.1.0","payload_sha256":"0000000000000000000000000000000000000000000000000000000000000000","origin":"init","tech":"rust","forge":"github","landed_at":"2026-08-29T00:00:00Z","parameters":{{"repo":"acme/widget","workflow":"worktree","style":"lines","nix":true,"scorecard":true,"code_scanning":"semgrep","trunk":"main","line_prefix":"stable/"}},"files":[{{"destination":"AGENTS.md","kind":"rendered","sha256":"0000000000000000000000000000000000000000000000000000000000000000","baseline_sha256":"0000000000000000000000000000000000000000000000000000000000000000"}}],"pins":{{}}}}"#
                ),
            )
            .expect("the record writes");
            let manifest = super::load(target)
                .expect("an earlier record loads")
                .expect("the record exists");
            assert_eq!(manifest.schema_version, schema);
            assert_eq!(manifest.git.checkout_mode, CheckoutMode::LinkedWorktree);
            // A record below the placement schema stated none, so the
            // block destinations are regions by their names alone; from
            // that schema on the record says so itself.
            assert_eq!(manifest.git.trunk, "main");
            assert_eq!(manifest.profile.release.style, Some(Style::Lines));
            assert_eq!(
                manifest.profile.release.line_prefix.as_deref(),
                Some("stable/")
            );
            assert!(manifest.capabilities.nix_packaging && manifest.capabilities.scorecard);
            assert_eq!(manifest.capabilities.code_scanning, Some(Provider::Semgrep));
            assert_eq!(
                manifest.files[0].placement,
                if schema < super::PLACEMENT_SCHEMA {
                    Placement::Region
                } else {
                    Placement::Whole
                },
                "a block destination below the placement schema reads as a region"
            );
            let rewritten = super::render(&manifest).expect("renders");
            let text = String::from_utf8(rewritten).expect("text");
            assert!(!text.contains("baseline_sha256"), "{text}");
            assert!(
                !text.contains("\"tech\""),
                "the flat identity moved: {text}"
            );
        }

        std::fs::write(target.join(super::MANIFEST_PATH), record(999)).expect("the record writes");
        let refused = super::load(target).expect_err("a schema-999 record refuses");
        assert_eq!(
            refused.reason(),
            crate::diagnostic::Reason::UnsupportedSchema
        );
        let message = refused.to_string();
        assert!(message.contains("999"), "{message}");
        assert!(message.contains(super::MANIFEST_PATH), "{message}");
        assert!(
            !message.to_lowercase().contains("bundle"),
            "the record schema stands alone: {message}"
        );
    }

    /// A record at schema 11 predates the merge form and carries no key,
    /// so it reads as `squash`, the form every such landing took, and the
    /// next write states the form at the current schema. A record that
    /// names `rebase` keeps it, and a form outside the two refuses as an
    /// invalid record rather than reading as either.
    ///
    /// SATISFIES git:the-merge-form-is-a-landing-parameter
    #[test]
    fn merge_form_of_a_schema_11_record_reads_as_squash() {
        let dir = tempfile::tempdir().expect("a scratch target exists");
        let target = camino::Utf8Path::from_path(dir.path()).expect("utf-8 path");
        std::fs::create_dir_all(target.join(".release-kit")).expect("the record dir writes");
        let record = |schema: u64, git: &str| {
            format!(
                r#"{{"schema_version":{schema},"rk_version":"0.1.0","origin":"init","landed_at":"2026-08-29T00:00:00Z","profile":{{"technologies":[],"release":{{"mode":"none"}}}},"git":{{"trunk":"master","checkout_mode":"linked-worktree","integration":"local"{git}}},"capabilities":{{"nix_packaging":false,"reporting_policy":false,"scorecard":false,"workflow_guards":true}},"parameters":{{"repo":""}},"files":[],"pins":{{}}}}"#
            )
        };
        std::fs::write(target.join(super::MANIFEST_PATH), record(11, "")).expect("writes");
        let manifest = super::load(target)
            .expect("a schema-11 record loads")
            .expect("the record exists");
        assert_eq!(manifest.schema_version, 11);
        assert_eq!(manifest.git.merge_form, super::MergeForm::Squash);
        let text = String::from_utf8(super::render(&manifest).expect("renders")).expect("text");
        assert!(text.contains("\"merge_form\": \"squash\""), "{text}");

        std::fs::write(
            target.join(super::MANIFEST_PATH),
            record(super::SCHEMA_VERSION, r#","merge_form":"rebase""#),
        )
        .expect("writes");
        let manifest = super::load(target)
            .expect("a current record loads")
            .expect("the record exists");
        assert_eq!(manifest.git.merge_form, super::MergeForm::Rebase);

        std::fs::write(
            target.join(super::MANIFEST_PATH),
            record(super::SCHEMA_VERSION, r#","merge_form":"merge""#),
        )
        .expect("writes");
        let refused = super::load(target).expect_err("an unknown form refuses");
        assert_eq!(refused.reason(), crate::diagnostic::Reason::RecordInvalid);
        assert!(refused.to_string().contains("merge form"), "{refused}");
    }

    /// The record is the one input a re-render reads, so a hand-edited
    /// record must not reach bytes the configured path could never write:
    /// a value the configuration reader refuses, and a value it would
    /// canonicalize, both refuse at deserialization.
    #[test]
    fn a_record_carrying_an_uncanonical_security_parameter_refuses() {
        let dir = tempfile::tempdir().expect("a scratch target exists");
        let target = camino::Utf8Path::from_path(dir.path()).expect("utf-8 path");
        std::fs::create_dir_all(target.join(".release-kit")).expect("the record dir writes");
        for (field, value) in [
            // A JSON escape, so the record parses and the value it decodes
            // to is the line feed the policy could never carry.
            ("security_contact", "team@acme.example\\nsecond line"),
            ("security_contact", "  team@acme.example  "),
            ("security_response", "90d"),
            ("security_response", "0 days"),
            ("security_response", "07 days"),
            ("security_response", "1 days"),
            ("security_response", ""),
        ] {
            let record = format!(
                r#"{{"schema_version":10,"rk_version":"0.1.0","origin":"init","landed_at":"2026-08-29T00:00:00Z","profile":{{"technologies":["rust"],"forge":"github","release":{{"mode":"automatic","driver":"rust","style":"trunk","line_prefix":"release/"}}}},"git":{{"trunk":"master","checkout_mode":"linked-worktree","integration":"local"}},"capabilities":{{"nix_packaging":false,"reporting_policy":true,"scorecard":false}},"parameters":{{"repo":"acme/widget","{field}":"{value}"}},"files":[],"pins":{{}}}}"#
            );
            std::fs::write(target.join(super::MANIFEST_PATH), record).expect("the record writes");
            let refused = super::load(target).expect_err("an uncanonical record refuses");
            assert!(refused.to_string().contains(field), "{field}: {refused}");
        }
    }

    #[test]
    fn alignment_orders_versions_numerically() {
        assert_eq!(alignment("0.1.0", "0.1.0"), Alignment::Aligned);
        assert_eq!(alignment("0.1.0", "0.2.0"), Alignment::BinaryNewer);
        assert_eq!(alignment("0.10.0", "0.9.9"), Alignment::TargetNewer);
        assert_eq!(alignment("0.1.0-rc.1", "0.1.0"), Alignment::BinaryNewer);
        assert_eq!(alignment("0.1.0", "0.1.0-rc.1"), Alignment::TargetNewer);
    }

    /// Pre-release identifiers order by semver precedence, not by text:
    /// `rc.10` is newer than `rc.2`, so a binary at `rc.2` must refuse a
    /// landing from `rc.10` rather than downgrade it — at any identifier
    /// length, so no integer width bounds the protection.
    #[test]
    fn alignment_orders_numeric_prerelease_identifiers_numerically() {
        assert_eq!(
            alignment("0.1.0-rc.10", "0.1.0-rc.2"),
            Alignment::TargetNewer
        );
        assert_eq!(
            alignment("0.1.0-rc.2", "0.1.0-rc.10"),
            Alignment::BinaryNewer
        );
        assert_eq!(alignment("0.1.0-rc.1", "0.1.0-rc.1"), Alignment::Aligned);
        assert_eq!(
            alignment("0.1.0-alpha", "0.1.0-alpha.1"),
            Alignment::BinaryNewer
        );
        assert_eq!(alignment("0.1.0-1", "0.1.0-alpha"), Alignment::BinaryNewer);
        assert_eq!(
            alignment("1.0.0-100000000000000000000", "1.0.0-99999999999999999999"),
            Alignment::TargetNewer,
            "identifiers past the u64 range still compare numerically"
        );
        assert_eq!(
            alignment("1.0.0-99999999999999999999", "1.0.0-100000000000000000000"),
            Alignment::BinaryNewer
        );
    }

    /// Build metadata carries no precedence: it never corrupts a numeric
    /// component and never separates two otherwise-equal versions.
    #[test]
    fn alignment_ignores_build_metadata() {
        assert_eq!(alignment("1.2.10+build", "1.2.9"), Alignment::TargetNewer);
        assert_eq!(alignment("1.2.9", "1.2.10+build"), Alignment::BinaryNewer);
        assert_eq!(alignment("1.0.0+alpha", "1.0.0+beta"), Alignment::Aligned);
        assert_eq!(
            alignment("1.2.10-rc.1+build", "1.2.10-rc.1"),
            Alignment::Aligned
        );
        assert_eq!(
            alignment("1.2.10-rc.1+build", "1.2.10"),
            Alignment::BinaryNewer
        );
    }
}