Versioning

Managing SDK versions doesn't have to be complicated. Packable automatically tracks changes to your API specification and helps you maintain consistent versioning across all your generated SDKs.

How Versioning Works

Every time you update your OpenAPI specification, Packable detects the changes and tracks them as a new version. This ensures that:

  • Your SDKs stay synchronized with your API
  • Breaking changes are clearly identified
  • Users can reference specific SDK versions
  • You maintain a complete history of your API evolution

Semantic Versioning

Packable follows Semantic Versioning (SemVer) principles for all generated SDKs:

semver
MAJOR.MINOR.PATCH
  • MAJOR: Incremented for breaking changes (e.g., removing an endpoint, changing request/response structure)
  • MINOR: Incremented for new features that are backward compatible (e.g., adding new endpoints)
  • PATCH: Incremented for backward-compatible bug fixes and documentation updates

Pre-release Versions

Packable supports pre-release versions for testing:

  • Alpha: 1.2.0-alpha.1 - Early testing
  • Beta: 1.2.0-beta.1 - Feature complete, bug testing
  • Release Candidate: 1.2.0-rc.1 - Production candidate

Use pre-release versions to get feedback from early adopters before releasing to all users.

Next Steps

Now that you understand versioning, explore:

  1. Set up automation to streamline your SDK releases
  2. Add custom code that persists across versions
  3. Learn about project structure to organize multiple APIs