manifest-tools/me.ahoo.wow.manifest.tools/CompatibilityReport

CompatibilityReport

data class CompatibilityReport(val changes: List<ManifestChange>)

The comparison of a service's Manifest with its baseline, the committed Manifest of its contract. A breaking change fails the gate (failed); a change that breaks on purpose, for a new major version, is recorded as the new baseline instead.

Constructors

CompatibilityReport

constructor(changes: List<ManifestChange>)

Properties

additive

val additive: List<ManifestChange>

breaking

val breaking: List<ManifestChange>

changes

val changes: List<ManifestChange>

failed

val failed: Boolean

Whether the gate fails: a breaking change.

Functions

render

fun render(): String

The report as text: a summary line, then each change on its own line, the breaking ones first.