Open 3D Engine版本控制和发布术语

Open 3D Engine (O3DE)版本编号

O3DE 使用MAJOR.MINOR.PATCH 语义版本控制 用于 engine.json, gem.json 和 project.json 文件中的所有 version 字段，以指示 API 和其他重要更改。

• MAJOR 用于 API 中断性更改
• MINOR 适用于添加新 API 或以非中断性方式更改 API 的非 API 重大更改
• PATCH 用于所有其他非 API 破坏性更改，通常是重要的修复

引擎显示版本使用YY.MM.PATCH，并且仅在 O3DE SDK 中使用。通过对 SDK 显示版本使用面向日期的方案，用户可以轻松判断引擎 SDK 的发布时间，但它不提供有关兼容性或所做更改类型的任何信息。

O3DE 发布术语

• Stable: 此功能已准备好供用户积极使用它进行开发。API 和功能可以被认为是稳定的，任何重要的新工作都将在进行更改之前捕获在 RFC 中。
• Preview: 此功能几乎完成并且很稳定。可能仍会有小的改变。
• Experimental: 此功能正在开发中。先不要依赖它;它可能会发生重大变化。

engine.json 中的引擎版本信息

O3DE 引擎版本信息存储在引擎根目录的engine.json 文件中。

例：

开发人员可以使用其 gem.json中的compatible_engines字段来指示其 Gem 已知与开发中名为o3de版本 2.0.0或更高版本的任何引擎或名为o3de-sdk但版本为1.2.0的 SDK 引擎兼容。

{
    "gem_name":"CustomGem",
    "compatible_engines": [
        "o3de>=2.0.0",
        "o3de-sdk==1.2.0"
    ]
}

Engine API

在engine.json的api_versions字段中指定的 API 版本目前基于引擎的Code文件夹中的内容，并且作为简单但有用的方式提供给开发人员，以便在他们希望其 Gem 或工具与多个引擎版本兼容时指示兼容性，除非对引擎的Code文件夹中的 API 进行了重大更改。

例：

创建包含 Editor 工具的 Gem 的开发人员可以更新其gem.json文件，以表明已知该 Gem 与 Editor API 的任何非破坏性版本兼容。

{
    "gem_name":"EditorToolGem",
    "engine_api_dependencies": [
        "editor~=1.0.0"
    ]
}