lightspeed - v1.0.0

lightspeed/release/maturity_baseline

Framework maturity and community operations baseline contracts for M47.

Types

ApiCompatibilityGate

API compatibility breakage check gate.

pub type ApiCompatibilityGate {
  ApiCompatibilityGate(
    name: String,
    expected: String,
    strict: Bool,
  )
}

Constructors 

  • ApiCompatibilityGate(
  name: String,
  expected: String,
  strict: Bool,
)

ContributorWorkflow

Contributor workflow baseline.

pub type ContributorWorkflow {
  ContributorWorkflow(
    name: String,
    stages: List(String),
    audit_artifact: String,
  )
}

Constructors 

  • ContributorWorkflow(
  name: String,
  stages: List(String),
  audit_artifact: String,
)

MaturityStage

Framework maturity stage for one release line.

pub type MaturityStage {
  Beta
  GA
}

Constructors 

  • Beta
  • GA

ReleaseHygieneGate

Release hygiene gate.

pub type ReleaseHygieneGate {
  ReleaseHygieneGate(
    name: String,
    required: Bool,
    evidence: String,
  )
}

Constructors 

  • ReleaseHygieneGate(
  name: String,
  required: Bool,
  evidence: String,
)

ReleaseLineBaseline

One release-line maturity baseline.

pub type ReleaseLineBaseline {
  ReleaseLineBaseline(
    line: String,
    stage: MaturityStage,
    versioning: VersioningPolicy,
    release_hygiene: List(ReleaseHygieneGate),
    api_compatibility: List(ApiCompatibilityGate),
    supply_chain: List(SupplyChainGate),
    contributor_operations: List(ContributorWorkflow),
    report_artifact: String,
  )
}

Constructors

SupplyChainGate

Supply-chain hygiene gate.

pub type SupplyChainGate {
  SupplyChainGate(name: String, required: Bool, evidence: String)
}

Constructors 

  • SupplyChainGate(name: String, required: Bool, evidence: String)

VersioningPolicy

Versioning and deprecation policy baseline.

pub type VersioningPolicy {
  VersioningPolicy(
    semver_required: Bool,
    breaking_change_requires_major: Bool,
    warning_releases_before_removal: Int,
    migration_notes_required: Bool,
    rfc_adr_required: Bool,
  )
}

Constructors 

  • VersioningPolicy(
  semver_required: Bool,
  breaking_change_requires_major: Bool,
  warning_releases_before_removal: Int,
  migration_notes_required: Bool,
  rfc_adr_required: Bool,
)

Values

api_breakage_gates_enforced 

pub fn api_breakage_gates_enforced() -> Bool

Check API breakage gates are strict and explicit.

api_compatibility_signature 

pub fn api_compatibility_signature(
  gates: List(ApiCompatibilityGate),
) -> String

Stable API compatibility gate signature.

beta_2_x_next_baseline 

pub fn beta_2_x_next_baseline() -> ReleaseLineBaseline

Beta 2.x-next maturity baseline.

contributor_operations 

pub fn contributor_operations(
  baseline: ReleaseLineBaseline,
) -> List(ContributorWorkflow)

Contributor operations accessor.

contributor_operations_signature 

pub fn contributor_operations_signature(
  workflows: List(ContributorWorkflow),
) -> String

Stable contributor operations signature.

contributor_operations_standardized 

pub fn contributor_operations_standardized() -> Bool

Check contributor operations are standardized.

contributor_workflows 

pub fn contributor_workflows() -> List(ContributorWorkflow)

Contributor operations baseline.

ga_1_x_baseline 

pub fn ga_1_x_baseline() -> ReleaseLineBaseline

GA 1.x maturity baseline.

line 

pub fn line(baseline: ReleaseLineBaseline) -> String

Release-line accessor.

maturity_policies_explicit 

pub fn maturity_policies_explicit() -> Bool

Check all release lines have explicit maturity policies.

release_hygiene_signature 

pub fn release_hygiene_signature(
  gates: List(ReleaseHygieneGate),
) -> String

Stable release hygiene signature.

release_line_artifact_signatures 

pub fn release_line_artifact_signatures() -> List(String)

Release-line artifact signatures for M47 reports.

release_lines 

pub fn release_lines() -> List(ReleaseLineBaseline)

M47 release-line maturity baselines.

report_artifact 

pub fn report_artifact(baseline: ReleaseLineBaseline) -> String

Report artifact accessor.

signature 

pub fn signature(baseline: ReleaseLineBaseline) -> String

Stable release-line baseline signature.

snapshot_signature 

pub fn snapshot_signature() -> String

Deterministic M47 snapshot signature.

snapshot_version 

pub const snapshot_version: Int

stage_label 

pub fn stage_label(stage: MaturityStage) -> String

Stable maturity-stage label.

supply_chain_hygiene_enforced 

pub fn supply_chain_hygiene_enforced() -> Bool

Check supply-chain hygiene gates are required across release lines.

supply_chain_signature 

pub fn supply_chain_signature(
  gates: List(SupplyChainGate),
) -> String

Stable supply-chain gate signature.

valid 

pub fn valid(baseline: ReleaseLineBaseline) -> Bool

Validate one release-line maturity baseline.

versioning_signature 

pub fn versioning_signature(policy: VersioningPolicy) -> String

Stable versioning signature.

✨ Search Document