1. Overview
  2. Versioning

Overview

Versioning

PackageX's SDK versioning policy is based on the semantic versioning standard.

For example, in version 5.9.2, 5 is the major, 9 is the minor, and 2 is the patch. When we release a new SDK version for new features or bug fixes, we increment one of these three version components depending on the type of change introduced.

Major

We increment a major version when the update contains breaking changes that are backwards incompatible with the latest version, such as:

  • Deleting a method or type
  • Deleting a response property
  • Modifying a method, property, or type
  • Modifying a property name or type
  • Modifying required parameters

Minor

We increment the minor version component when the version contains new features that are backwards compatible with the latest version, such as:

  • Adding a new type
  • Adding a new property or method to a response object
  • Adding a new optional parameter to a method

Patch

We increment the patch version component when the version contains backward-compatible bug fixes, such as:

  • Fixing a bug where a method or property was returning the wrong value
  • Fixing a bug where a method or property was throwing an error
  • Fixing a bug where a method or property was not working as expected