Releases & Semantic Versioning

Muxy’s Javascript SDK adheres to the Semantic Versioning release philosophy.

What this means for you is that breaking or backwards-incompatible changes will always result in a new major release, and that you always have the option of using a version of the library that will not accidentally break your extension.

From the Semantic Versioning website:

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.

We publish new versions of the SDK on npm and our CDN regularly, and the most recent code changes are developed in the open on GitHub.

UMD vs ESM

Each release has two versions:

CDN Releases

Specific SDK versions can be downloaded or referenced directly in an extension at the URL:

https://ext-cdn.muxy.io/medkit/<version>/medkit.umd.js

‘<version>’ is a three-dotted semantic version string containing the Major.Minor.Patch version information (or one of the special-cased ‘latest’ or ‘testing’). E.g.

Specific version that will never change:

https://ext-cdn.muxy.io/medkit/2.0.1/medkit.umd.js

Latest version that may update with breaking changes:

https://ext-cdn.muxy.io/medkit/latest/medkit.umd.js

Bleeding-edge version that contains code to be tested and possibly bugs:

https://ext-cdn.muxy.io/medkit/testing/medkit.umd.js

NPM Releases

If you are using a build system, it can be easier to install the latest version of the SDK using npm:

npm install --save @muxy/extensions-js

Or specific versions:

npm install --save @muxy/extensions-js@2.0.0

This will make the UMD and ES Module version available at