Skip to main content

VersionReport

Struct VersionReport 

Source
pub struct VersionReport {
    pub declared: String,
    pub tool: String,
    pub agree: bool,
    pub last_release: Option<String>,
    pub bump: String,
    pub commits_imply: Option<String>,
    pub next: Option<String>,
    pub decided_by: DecidedBy,
    pub contract_unreadable: Option<String>,
    pub changes: Vec<Change>,
}
Expand description

What the version is, what the public contract requires it to become, and what the commits since the last release say about themselves.

next is the contract’s answer (ADR 0051): the analysis’ required_version, or the smallest release above the last when that requirement is the last release itself. The commit inference is evidence — bump and commits_imply — and never the answer: when the contract cannot be measured next is absent, decided_by is undecided and contract_unreadable says why. The selection is crate::release::version::select, the one function release bump also takes its default target from.

Fields§

§declared: String

The version the crate manifest declares — the one place it is authored.

§tool: String

The version bin/majordomus prints: what its projection, share/version.txt, states.

§agree: bool

Whether that projection is current. generate --check refuses a stale one and scripts/release-version --check proves the tool prints it; this is the same question asked by the executable, so every surface can show the answer.

§last_release: Option<String>

The last release: the highest version the layer records (the newest version tag when it records none) — the baseline release analyze measures the contract from, so the contract and the commit evidence describe one window.

§bump: String

What the commit subjects since it imply: major, minor, patch, or none. Evidence only — the contract decides next; release analyze reports where the two disagree.

§commits_imply: Option<String>

The version that bump would produce from the last release (from the declared version when nothing was released yet). Evidence only, even when the contract cannot answer.

§next: Option<String>

The next version. When the contract could be measured, the version it requires: the declared version when that already satisfies it, otherwise the smallest one it allows — and, when that is the last release itself, the smallest release above it. Absent when nothing would be released, and when the contract could not be measured (decided_by: undecided): an unmeasurable baseline is refused, not guessed.

§decided_by: DecidedBy

Who answered next.

§contract_unreadable: Option<String>

Why the contract could not answer, when decided_by is undecided.

§changes: Vec<Change>

How many commits since the last release, and of what kind — the evidence for the bump, so that a surprising answer can be checked rather than believed.

Trait Implementations§

Source§

impl Clone for VersionReport

Source§

fn clone(&self) -> VersionReport

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for VersionReport

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for VersionReport

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for VersionReport

Source§

impl JsonSchema for VersionReport

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for VersionReport

Source§

fn eq(&self, other: &VersionReport) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for VersionReport

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for VersionReport

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more