Struct Policy 

pub struct Policy {
    pub schema: String,
    pub mode: Mode,
}

The compatibility policy, named and versioned.

use majordomus_cli::release::compat::{Impact, Policy, POLICY_SCHEMA};
use majordomus_cli::release::version::Version;
let policy = Policy::for_version(Version::parse("0.5.0").unwrap());
assert_eq!(policy.schema, POLICY_SCHEMA, "a verdict carries the rules it was reached under");
assert_eq!(policy.required_of(Impact::Major), Impact::Minor);

Fields

schema: String

majordomus/version-policy/v1.

mode: Mode

Which rule is in force, decided by the baseline version alone.

Implementations

impl Policy

pub fn for_version(base: Version) -> Policy

The policy that governs a project at this version.

use majordomus_cli::release::compat::{Mode, Policy};
use majordomus_cli::release::version::Version;
// the baseline decides the mode, not the version being written
assert_eq!(Policy::for_version(Version::parse("0.1.0").unwrap()).mode, Mode::Pre1_0Strict);
assert_eq!(Policy::for_version(Version::parse("2.3.4").unwrap()).mode, Mode::Semver);

pub fn required_of(&self, implied: Impact) -> Impact

The smallest release this impact is allowed to ship as.

An unchanged surface owes nothing under either mode. This runs over every tree, not only over a release, and most commits are behind the boundary: demanding a bump for each of them would make the gate a thing to be worked around within a day.

use majordomus_cli::release::compat::{Impact, Policy};
use majordomus_cli::release::version::Version;

let pre = Policy::for_version(Version::parse("0.5.0").unwrap());
assert_eq!(pre.required_of(Impact::None), Impact::None);
assert_eq!(pre.required_of(Impact::Minor), Impact::Minor);
assert_eq!(pre.required_of(Impact::Major), Impact::Minor, "0.x floors a removal at a minor");

let one = Policy::for_version(Version::parse("1.0.0").unwrap());
assert_eq!(one.required_of(Impact::Major), Impact::Major);

pub fn statement(&self) -> &'static str

How this policy explains itself, in the plan and in --explain.

use majordomus_cli::release::compat::Policy;
use majordomus_cli::release::version::Version;
let policy = Policy::for_version(Version::parse("0.5.0").unwrap());
assert!(policy.statement().contains("below 1.0.0"));

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Policy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Policy

impl JsonSchema for Policy

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

The name of the generated JSON Schema.

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

Returns a string that uniquely identifies the schema produced by this type.

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

Generates a JSON Schema for this type.

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.

impl PartialEq for Policy

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Policy

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Policy