Skip to content

VERSIONING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.7 KB

VERSIONING.md

File metadata and controls

52 lines (37 loc) · 1.7 KB
Raw

Versioning Strategy

This project uses Semantic Versioning (SemVer 2.0.0) for all packages.

Version Format

All packages follow the MAJOR.MINOR.PATCH format:

  • MAJOR - Breaking changes that require migration steps
  • MINOR - New features that are backward-compatible
  • PATCH - Bug fixes and minor improvements

Package Versioning

Package Current Version Stability
@stellar-address-kit/core-ts 0.1.0 Alpha
stellar_address_kit (Dart) 1.0.1 Stable
core-go (Go) 0.1.0 Alpha

Pre-release

Packages in 0.x.y are in pre-release. During this phase:

  • Minor versions may include breaking changes
  • API stability is not guaranteed
  • Frequent releases are expected

Release Process

  1. Change Collection: Developers create changeset files using pnpm changeset
  2. Version Bump: When ready, run pnpm changeset version to update versions and changelog
  3. Pull Request: Open a PR with the version changes
  4. Tag & Release: Once merged, create a git tag and GitHub release
  5. Publish: Automated CI publishes to NPM/pub.dev/Go proxy

Breaking Changes

Breaking changes require:

  1. A MAJOR version bump
  2. Migration guide in the changelog
  3. Deprecation warnings for one minor version before removal

Migration Guides

Migration guides for breaking changes are maintained in:

  • docs/migration/memo-to-muxed.md - Memo to M-address migration
  • docs/migration/compatibility.md - Cross-version compatibility notes

Compatibility Matrix

Spec Version core-ts core-dart core-go
1.0.0 0.1.0 1.0.1 0.1.0