Releases

We aim to release the Text Editor SDK in a consistent, predictable way. We typically release new versions of the SDK on Tuesdays. We occasionally release urgent patches on other days of the week.

Learn more about how we version our releases, how we release experimental functionality, and how we deprecate functionality below.

Semantic versioning

The Text Editor SDK follows semantic versioningopen in new window. Updates to the SDK are delivered via a thin wrapper script (e.g., @grammarly/editor-sdkopen in new window), which dynamically loads Grammarly behind the scenes. The wrapper script automatically retrieves the latest patch release for the specified major and minor version. This approach allows apps to get the latest backward-compatible fixes and improvements without needing to upgrade any dependencies.

EXAMPLE

The wrapper script @grammarly/editor-sdk@1.5.0 may internally load version 1.5.1 because it fetches the latest patch release (1.5.x in this example).

All changes are documented in the changelog.

Experimental functionality

We occasionally release experimental functionality, so you can preview it and provide feedback. Experimental functionality can be removed or changed without warning and may not follow semantic versioning. On a per-release basis, experimental functionality might be available to all developers or a subset of developers.

Because of its likelihood to change, experimental functionality should not be used in production except for limited testing.

How will you know if functionality is experimental? In the API Reference, look for the experimental tag. A warning message will also be displayed on the documentation page(s).

We use experimental releases to do early testing on new features, and your feedback on these features is valuable! When you see something tagged as experimental, we encourage you to give it a try and share your feedbackopen in new window.

Deprecated functionality

We will occasionally deprecate functionality, meaning that parts of the API may be removed in a future major release. In alignment with semantic versioning, we will always release at least one minor version with a deprecation notice before removing functionality in a future major release.

Look for the deprecated tag in the API Reference to see if functionality is deprecated.

Last Updated: 5/13/2022, 7:06:50 PM