Skip to content

MAINTENANCE.md

Latest commit

 

History

History
61 lines (47 loc) · 2.9 KB

MAINTENANCE.md

File metadata and controls

61 lines (47 loc) · 2.9 KB
Raw

CocoaMQTT 2.x maintenance policy

release/2.x is the long-term maintenance line for CocoaMQTT 2. Its first release is 2.4.0, based on commit c09666c86084212736d68fa7c652d20ed4753c4c, the final master commit before the CocoaMQTT 3 transport architecture changes.

Scope

The 2.x line accepts:

  • security and protocol-correctness fixes;
  • regressions and high-impact bug fixes;
  • compatibility fixes for supported Apple platforms, Swift, Swift Package Manager, and CocoaPods;
  • documentation and test improvements needed to support those fixes.

The 2.x line does not accept new transport architecture, dependency migrations, minimum-platform increases, or broad new features. CocoaAsyncSocket remains the TCP transport, and Starscream remains the fallback WebSocket transport on older supported Apple operating systems.

Applicable fixes developed on master should be reviewed and cherry-picked into release/2.x; the branches must not be merged wholesale.

Compatibility

Patch releases in this line preserve the 2.4 public API and supported platform matrix. CI builds both package products, validates CocoaPods, and checks the public API against both 2.3.0 and the pull request base commit.

Merging a stable version metadata update into release/2.x starts the Check CocoaMQTT 2.x Release workflow. If that version is not already tagged, the workflow revalidates release metadata, API compatibility against both 2.3.0 and the preceding stable 2.x release, package tests, and CocoaPods. It does not create or publish a tag.

The final 2.x Release Ready job rechecks that the validated commit is still the current branch head and reports its full commit SHA. After that job succeeds, a maintainer creates an annotated tag for exactly that SHA and pushes it. Do not create a stable 2.* tag before this job passes. The tag push runs the distribution checks, including validation against the tagged SPM and CocoaPods sources. Repository rules prevent stable 2.* tags from being moved or deleted.

ThreadSafeDictionary.Iterator intentionally changed from an index-based live iterator to a dictionary snapshot iterator. Restoring the old concrete iterator would reintroduce invalid-index crashes during concurrent mutation. The type continues to conform to Collection, while ordinary iteration uses a stable snapshot. Index-based Collection access is not safe across mutations; use snapshot() for multi-step indexed access.

The deprecated decoder overloads without an explicit protocol version assume MQTT 5 packet data. ConcurrentAtomic property assignment and mutate retain their 2.3 source signatures but execute synchronously in 2.4. A mutation closure must not read from or write to the same wrapper.

Support lifetime

CocoaMQTT 2.x will be maintained for at least 12 months after CocoaMQTT 3.0.0 is released. Any end-of-life date will be announced at least six months in advance in the repository README and GitHub releases.