SpatialOS release policies
SDK releases are categorised as major, minor or patch and represented using standard semantic versioning (
- Major releases include breaking changes for new features and previously warned deprecation. Will be accompanied by an upgrade guide as well as release notes.
- Minor releases include new features and no breaking changes. They don’t require an upgrade guide, but release notes will be provided.
- Patch releases contain only fixes and no breaking changes. They don’t require an upgrade guide. Release notes will typically be provided.
Breaking changes and deprecations
Occasionally, it is in the product’s best interest to change the functionality of or remove an API. This will result in a breaking, or non-backwards-compatible, change.
To prepare users for these updates, we will, whenever possible, make sure there is at least one minor or major version in which this API is deprecated. The upcoming change or removal to the API will be noted in the release notes and/or compilation warnings.
The breaking change will only occur in a major version, and any necessary upgrade instructions will be provided in the accompanying upgrade guide.
We’ll continue to provide patch releases with bug fixes for major versions of SpatialOS up to 9 months after their initial release date. Only the latest released minor version will be patched. Similarly, we only maintain and update documentation for the latest minor version of a major release.
Game engine support
We will endeavor to support the latest stable and recommended version of a game engine in either the next minor or major integration release following its launch, or in a release less than 3 months afterwards.
When we introduce support for a new version of a game engine, we will always support at least one of the previously supported versions (normally the highest) in parallel in order to facilitate smooth upgrades.
Though we strive not to, we do reserve the right to make out-of-policy releases, deprecations, or breaking changes due to issues such as security risks, or fixes with exceptional technical burden.
Pre-alpha: Something that is feature incomplete. Or, part of an existing product that contains a new experiment for a feature. Not necessarily planned to become stable.
Does not adhere to our bug fixing or breaking change policies. Only available to specific customers. Not recommended for production.
Alpha: Feature incomplete and may have some significant bugs. Planned to become stable.
Not recommended for production.
Stable: A complete feature that meets the needs of a set of users for production games. We plan to continue working on this.
Deprecated: Not currently working on or planning to work on features or fixes. Could be removed permanently with notice.
Not recommended for production.
spatial CLI releases
We release the
spatial CLI separately from the SDKs. When a new
spatial version is available, you’ll see a message in the CLI saying that you can run
spatial update to get the latest version.
We deprecate each
spatial version 90 days after we release the next version. Once a version is deprecated, it’s possible that commands won’t work, or will behave unexpectedly. We recommend you update your
spatial version as soon as you can when a new version is available.