Framework

Versioning

How and when Joystick's versions change and what that means for your project.

Joystick's versioning is designed to keep all of the framework's packages in parity with one another. Although the framework consists of four different packages, if any of those packages change, all packages have their version bumped (even if a package doesn't have changes).

There are two release tracks for all Joystick packages: production and canary.

Production Packages

These include @joystick.js/ui, @joystick.js/node, @joystick.js/cli, and @joystick.js/test. These are the production-safe versions of Joystick's packages.

Canary Packages

These include @joystick.js/ui-canary, @joystick.js/node-canary, @joystick.js/cli-canary, and @joystick.js/test-canary. The canary version of each package is considered the "nightly" version. Packages with the -canary suffix contain the latest features, however, unlike the production version are considered unstable and potentially buggy.

Canary packages should be used with extreme caution and only if you know what you're doing.

Updating Joystick

To update your Joystick app to the latest version, via the Joystick CLI @joystick.js/cli, run the joystick update command from the root of your project:

Terminal

cd <my_project> && joystick update

This also works for the -canary suffixed releases, however, using joystick-canary update like so:

Terminal

cd <my_project> && joystick-canary update