Version Management

Unlayer provides flexibility for developers by offering different release channels for the builder and the ability to lock the builder to a specific version. By using these options, you can control which version of the builder is loaded in your application, whether it be the latest cutting-edge version or a stable release.

This is especially useful for developers who want to:

• Use the latest features and improvements as soon as they are available.
• Ensure stability by locking their application to a known stable version.
• Lock the builder to a specific version number to prevent unexpected updates.

Release Channels

Unlayer supports two main release channels:

1. Stable: The default and most reliable release channel. This version contains thoroughly tested features and is recommended for production environments. It provides maximum stability and minimal changes over time.
2. Latest: The edge version that contains the latest features, bug fixes, and improvements. It is updated more frequently and includes the most recent changes. This is ideal for developers who want to test new features early.

Using a Release Channel

You can specify which release channel or version of the builder to load by passing the version option when initializing the builder. By default, the builder loads the stable version unless otherwise specified.

unlayer.init({
  version: 'latest' // Specify 'stable' or a specific version number
});

Options for version:

• stable: Loads the stable release of the Unlayer builder. This is the default option and is recommended for most production environments.
• latest: Loads the latest edge release, which includes new features, improvements, and bug fixes. This version may be less stable but includes the most up-to-date changes.
• Specific Version Number: You can lock the builder to a specific version by specifying a version number (e.g., 1.63.2). This is useful if you want to ensure that the builder doesn’t automatically update to a newer version, preventing potential breaking changes.

Changelog

📘

A versioned changelog is available here: Changelog

Example Use Cases

Production Environment

In a production environment, you may want to load the stable version to ensure that your users experience a reliable and consistent builder.

unlayer.init({
  version: 'stable', // Stable and reliable for production
});

Development Environment

In a development or staging environment, you might use the latest release channel to test new features and improvements as they become available.

unlayer.init({
  version: 'latest', // Use the latest version for testing new features
});

Version Locking

If your application relies on a specific version of the builder and you want to avoid any unexpected changes due to updates, you can lock the builder to a specific version number.

unlayer.init({
  version: '1.63.2', // Lock to a specific version
});

Best Practices

• For production environments, we recommend using the stable release channel to minimize the risk of introducing bugs or instability due to frequent updates.
• Use the latest release channel in development environments to experiment with the newest features and provide feedback on upcoming changes.
• Lock the builder to a specific version if you require strict control over the features and stability of the editor in your application.

Notes

• You can switch between release channels at any time by updating the version parameter in your initialization script.
• Version locking is ideal for applications where stability and predictability are critical, and you want to avoid the possibility of automatic updates affecting the end-user experience.