Skip to content

Engine semantic versioning #779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Engine semantic versioning #779

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a94eebe
Added page on engine versioning
kpal81xd Jun 30, 2025
cbf1c04
Lint fix
kpal81xd Jun 30, 2025
fb82bea
Commented alpha prerelease section in versioning documentation
kpal81xd Jul 1, 2025
c12a845
Rewrote minor and patch to indicate we follow semver and. mention we …
kpal81xd Jul 1, 2025
d6e79b2
Merge branch 'main' into versioning
kpal81xd Jul 1, 2025
723715c
Fix punctuation in NPM usage recommendation in versioning documentation
kpal81xd Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/user-manual/engine/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Semantic Versioning
sidebar_position: 3
---

The engine supports both prereleases and releases. This page outlines the hierarchy of each version type and what they represent.

### `alpha` (not implemented yet)

An alpha prerelease is the most unstable type of release purely for testing features in a branch for a PR. This is useful for mobile debugging and profiling new ideas without having to deploy a full release.

### `beta`

A beta prerelease represents all the latest features that have been approved from the PR stage and have been merged into `main` the main development branch. These features have been initially tested but not gone through a more thorough testing process like for an official minor release. This is useful if you have some new API you want to take advantage for in other projects but do not want to build the engine from source as a submodule.

### `preview`

A preview prerelease is the last type of prerelease which contains all the latest features or breaking changes prior to a minor release or bug fixes prior to a patch release. This is useful for testing large and complex projects in the Editor and additionally mobile testing and profiling.

### `patch`

This is the smallest type of release which contains **non-breaking** changes to the engine. This will exclude any API changes or new features - only bug fixes. The Editor will only show the latest patch version for any particular minor release.

### `minor`

This release contains all new features and additions to the engine API along with deprecations and breaking changes. The Editor supports both the latest minor and the previous minor to allow for migrations in API to occur across larger projects.

### `major`

This type of release is reserved for large changes or additions to the engine API. A recent example of such was the addition of full WebGPU support and the removal of WebGL 1.0 support moving from v1.x.x to v2.x.x.