Introduction
Cowboy follows a clear versioning strategy to balance innovation with stability. This page explains how versions are numbered, released, and maintained.
Transparency: All version changes are tracked, documented, and announced well in advance.
Node Software Version (cowboy-node)
- Tracks the client implementation.
- Aligns with protocol versions; patches do not change protocol.
SDK Version
- Tracks API surface and developer experience.
- Independent from protocol; publishes its own semver.
Documentation Version
- Tracks content and structure.
- Tags align to major protocol milestones (e.g.,
docs-v0.1).
Compatibility Guarantees (Essentials)
Backwards Compatibility
- Minor protocol releases are backwards compatible for existing actors.
- No mandatory upgrades for actor developers on minor bumps.
Breaking Changes
- Announced well in advance with migration notes.
- Testnet period precedes mainnet activation.
Deprecation Policy (Typical)
- Deprecate with warnings → grace period → removal in a major release.
Long-Term Support (LTS)
- Early-stage project: LTS policy will be announced with future milestones.
Announcements & Communication
- Primary channel: GitHub Releases (
cowboyinc/cowboy) and documentation changelog.
- Major releases: advance notice with migration notes; patch releases: announced on release.
