Upgrading

Copy Markdown View Source

Per-version notes, newest first. For the protocol package's own release notes, see its CHANGELOG; this page covers THIS library's releases.

0.4.0

The protocol dependency now selects bounded_authority_protocol == 0.2.0 exactly, matching the authority suite's recertified protocol identity. This is a pre-1.0 minor release because consumers retaining BAP 0.1.x cannot solve the new exact dependency line. BARA's four signing APIs, return shapes, key-handle contract, telemetry, and produced V1 wire forms are unchanged.

Run mix deps.get and confirm your lock contains one BAP 0.2.0 entry. Do not override BARA back to BAP 0.1.x or retain parallel BAP lines.

0.3.0

Pre-1.0 feature release carrying everything the proposed stability contract enumerates: the value-free telemetry surface, the gate battery (coverage floor, dialyzer, doc warnings, dependency audits), the package boundary check, the three-cell CI matrix, the full guide set, the Igniter installer, the doctor preflight, and the supply-chain workflow. The contract itself is NOT yet operative — 1.0 is deferred until the release sees real consumer use (owner direction, 2026-08-26); until then the pre-1.0 SemVer §4 policy applies.

Unreleased → (next)

  • Telemetry: the four signing entry points now emit a value-free two-event surface — [:bounded_authority_report_adapter, :sign, :start|:stop]. You will observe the new events only after attaching a handler to those exact event names (:telemetry dispatches by exact name; there is no wildcard attach). No handler is attached by the library. A new runtime dependency (:telemetry ~> 1.3, zero transitive deps) entered the package's requirements.
  • CI/gates (no API change): coverage floor, dialyzer, doc warnings, dependency audits, and the package boundary check run in mix ci; the workflow runs a three-cell Elixir/OTP matrix.

0.2.1

  • Documentation-only release (links into the repository's examples/ fixed for the published docs).

0.2.0

  • The protocol dependency moved from a git pin to the public Hex package (~> 0.1.1 at the time). Lockfiles that referenced the private git remote should mix deps.get fresh.

The (proposed) 1.0 stability contract

PROPOSED, not yet operative — 1.0 is deferred until this release line sees real consumer use and the surface settles (owner direction, 2026-08-26). When 1.0 is cut, the following becomes the PUBLIC SURFACE — breaking changes to it then require a major version (SemVer §4's pre-1.0 carve-out ends):

  • The four signing functions and their return shapes: sign_report/3 → {:ok, %{grant: binary, proof: binary}}, sign_anchor/3 → {:ok, %{anchor: binary}}, sign_grant/3 → {:ok, %{grant: binary}}, sign_key_transition/3 → {:ok, %{key_transition: binary}}, and their @spec input maps (report(), anchor_input(), grant_input(), transition_input() + the opts maps).
  • The four closed error sets — sign_error/0, anchor_sign_error/0, grant_sign_error/0, transition_sign_error/0 — including the fixed {:producer_error, :invalid} tuple shape.
  • The key-handle behaviour: sign/2, public_key/1, thumbprint/1, key_identity/1, signing_identity/1 and their {:ok, _} | {:error, _} contracts.
  • The telemetry surface: BoundedAuthorityReportAdapter.Telemetry's public functions (Telemetry.sign_span/2, Telemetry.emit_start/1, Telemetry.emit_stop/3, Telemetry.objects/0, Telemetry.classes/0 — the BoundedAuthorityReportAdapter.Telemetry module), the two event names, and the value-free metadata contract (adding a metadata KEY is breaking by definition — the closed shape IS the contract).
  • The dependency posture: the library depends only on the public protocol package (plus :telemetry) — a runtime dependency on anything else is breaking.

Reserved break-rights (changes that may land in a MINOR)

The following may change without a major, each announced in the CHANGELOG:

  • Security fixes, including ones that narrow behavior (a construct previously accepted that should never have been).
  • Behavior-correcting fixes where the shipped behavior contradicts the documented contract.
  • New compiler warnings or dialyzer findings becoming errors (raise your floor, not your lockstep).

Frozen regardless

The wire formats this library produces are the protocol package's, frozen per its contract-major discipline: a proof, grant, anchor, or transition compact signed by version N verifies under the protocol's rules for that version's wire profile. This library never invents or extends a wire format.