lightspeed/release/policy
Stable API/deprecation/support policy for 1.0.0 GA.
Types
Compatibility target versions tracked for GA parity.
pub type CompatibilityTarget {
CompatibilityTarget(
phoenix_version: String,
liveview_version: String,
protocol_name: String,
protocol_version: Int,
patch_stream_version: Int,
)
}
Constructors
-
CompatibilityTarget( phoenix_version: String, liveview_version: String, protocol_name: String, protocol_version: Int, patch_stream_version: Int, )
Deprecation policy boundary.
pub type DeprecationPolicy {
DeprecationPolicy(
warning_releases_before_removal: Int,
removal_requires_major_bump: Bool,
migration_notes_required: Bool,
rfc_adr_required: Bool,
)
}
Constructors
-
DeprecationPolicy( warning_releases_before_removal: Int, removal_requires_major_bump: Bool, migration_notes_required: Bool, rfc_adr_required: Bool, )
Frozen compatibility matrix entry.
pub type MatrixEntry {
MatrixEntry(milestone: String, gate: String, evidence: String)
}
Constructors
-
MatrixEntry(milestone: String, gate: String, evidence: String)
Consolidated release policy for one GA line.
pub type ReleasePolicy {
ReleasePolicy(
version: String,
compatibility: CompatibilityTarget,
deprecation: DeprecationPolicy,
support: SupportPolicy,
matrix: List(MatrixEntry),
)
}
Constructors
-
ReleasePolicy( version: String, compatibility: CompatibilityTarget, deprecation: DeprecationPolicy, support: SupportPolicy, matrix: List(MatrixEntry), )
Long-term support boundaries for GA and maintenance tracks.
pub type SupportPolicy {
SupportPolicy(
ga_line: String,
maintenance_line: String,
eol_line: String,
minimum_supported_protocol_version: Int,
)
}
Constructors
-
SupportPolicy( ga_line: String, maintenance_line: String, eol_line: String, minimum_supported_protocol_version: Int, )
Values
pub fn compatibility(
policy: ReleasePolicy,
) -> CompatibilityTarget
Compatibility target accessor.
pub fn deprecation(policy: ReleasePolicy) -> DeprecationPolicy
Deprecation policy accessor.
pub fn matrix_signature(entries: List(MatrixEntry)) -> String
Stable matrix signature.
pub fn policy_signature(policy: ReleasePolicy) -> String
Stable policy signature for reproducible GA checks.
pub fn valid(policy: ReleasePolicy) -> Bool
True when policy aligns with runtime/package freeze constraints.