Skip to content

Releases

This page summarizes public release highlights from CHANGELOG.md.

Use it to decide whether a release affects your runtime behavior, dependency alignment, or migration work.

This page is consumer-facing guidance, not a second changelog. If there is any doubt, CHANGELOG.md is authoritative.

  1. Open the target entry in CHANGELOG.md and confirm the exact package line you plan to adopt.
  2. Check whether your integration is contract-only, Capacitor runtime, or both.
  3. Validate version pairings in a branch before production rollout.

Minimum release-read discipline for production teams:

  • Do not upgrade from tag/version name alone; read Changed, Fixed, and Security first.
  • Do not assume platform parity unless the entry explicitly states it.
  • Do not skip device-level validation for Capacitor integrations.

If you are new to package selection, use the Packages hub first.

When you evaluate a release entry, check in this order:

  1. Version matrix: package versions and native artifact references, when provided.
  2. User impact: explicit behavior differences that could affect your app.
  3. Upgrade notes: concrete required actions or version pairings.
  4. Breaking changes: whether there is declared migration risk.
  5. Durable evidence: links to npm/Maven/iOS release records.

If a release includes only partial evidence for your stack, treat it as informative and validate behavior in your own CI before production rollout.

Fast triage path:

  1. Confirm whether your current version and target version are in the same major line.
  2. Read user-impact and upgrade-notes bullets before implementation details.
  3. Decide rollout type: safe patch, controlled minor, or migration-required.

Contract-only consumers (@ddgutierrezc/legato-contract)

Section titled “Contract-only consumers (@ddgutierrezc/legato-contract)”
  • Prioritize Changed entries that affect semantics, events, capabilities, or error expectations.
  • Re-run compile-time checks and contract-centered tests that depend on event payloads and invariants.

Capacitor app consumers (@ddgutierrezc/legato-capacitor + contract)

Section titled “Capacitor app consumers (@ddgutierrezc/legato-capacitor + contract)”
  • Prioritize runtime behavior notes, native artifact alignment, and setup lifecycle expectations.
  • Re-run real-device smoke tests for playback lifecycle, queue updates, remote controls, and capability gating.
  • Prioritize evidence links and distribution parity claims across npm, Maven, and iOS release records.
  • Keep release communications aligned with factual CHANGELOG.md claims only.

Low-risk consumers (contract compile-time only)

Section titled “Low-risk consumers (contract compile-time only)”
  • Verify no contract semantic shift affects your event/error/capability assumptions.
  • Run type-check and contract-focused tests before merging.

Runtime-critical consumers (playback in production)

Section titled “Runtime-critical consumers (playback in production)”
  • Verify release notes for runtime parity and authenticated media behavior changes.
  • Run real-device smoke tests across queue, lifecycle, remote controls, and capability-gated actions.
  • Require durable evidence links for the artifacts you must audit (npm/Maven/iOS as applicable).
  • Record changelog section references used for approval in your internal release ticket.
Change type in notesMost affected consumersTypical action
Contract semantics/types/events@ddgutierrezc/legato-contract users (with or without Capacitor)Re-check compile-time assumptions and event/error handling branches.
Capacitor runtime behavior@ddgutierrezc/legato-capacitor app integratorsRun device-level smoke tests for playback lifecycle, queue, and remote events.
Native distribution alignmentTeams tracking Android/iOS native artifacts explicitlyValidate published artifact versions and repository evidence links.
Governance/docs process updatesMaintainers and release operatorsConfirm communication and evidence requirements are met.
  • Shared playback headers are now part of the stable public package line.
  • Stable package line:
    • @ddgutierrezc/legato-contract@1.1.0
    • @ddgutierrezc/legato-capacitor@1.1.0
  • Stable native distribution line called out in changelog: dev.dgutierrez:legato-android-core:1.1.0 and legato-ios-core v1.1.0.
  • Public contract additions: HeaderGroup and Track.headerGroupId.
  • Compatibility preserved: Track.headers remains supported as the per-track override path.

Consumer action baseline for this line:

  • Keep @ddgutierrezc/legato-contract and @ddgutierrezc/legato-capacitor aligned to 1.1.0 when adopting shared groups.
  • For Capacitor apps, validate setup({ headerGroups }), unknown-group fail-fast behavior, and mixed-token playlists on real devices.
  • For contract-only users, update your track modeling rules to include headerGroupId semantics and precedence expectations.

For implementation guidance, use:

For older entries (including 0.1.x lines and release-specific tags such as contract-publish-* and capacitor-publish-*), read the root CHANGELOG.md history.

Upgrade workflow before adopting any release

Section titled “Upgrade workflow before adopting any release”
  1. Compare your current package versions against the release version matrix.
  2. Read Changed, Fixed, and Security sections for behavior-impacting changes.
  3. Apply update in a branch and run your app-level playback regression checklist.
  4. If capabilities/semantics changed, re-check UI gating logic built on getCapabilities() and error.code.
  5. For enterprise rollouts, attach durable evidence links from the changelog to your approval/change record.

For a step-by-step upgrade checklist, continue with Migration and Versioning.

For package selection and role boundaries, use Packages and Getting Started.