diff --git a/com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md b/com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md index 641ee7b6b..805cf5e5a 100644 --- a/com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md +++ b/com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md @@ -65,3 +65,23 @@ the EOS Developer Portal. After being installed via the Tool, update the repo [readme](/com.playeveryware.eos/README.md) to ensure it lists the correct version and that any links on the readme are up to date. + +## Read the Release Notes While Upgrading +Epic publishes Release Notes with each new version of the EOS SDK. +The Release Notes can be read either on the Epic Games Developer Portal, +or in the [documentation's EOS SDK Release Notes page](https://dev.epicgames.com/docs/epic-online-services/release-notes). + +Epic will call out *Breaking changes* in the Release Notes. +These may indicate actions that are required for your upgrade, such as new API requirements, +changed function names, or permission changes that require configuration in the portal. + +Some changes only affect the `C` level, and are already handled in other released SDK folders. +For example, the `1.16.4` integration had a breaking change where `eos_[PLATFORM]_types.h` moved +definitions to `eos_common.h`. In the `C#` SDK for this release, Epic's generated C# files +already moved and handled the change. + +## Update EOS SDK Package Information +The plugin's `package.json`, and a few other places, mention the version of the EOS SDK being utilized. +When upgrading, the implementor should update all relevant `package.json` files to mention the newer version of the SDK. +Inside the `CHANGELOG.md` file, it should be noted when new versions of the SDK are implemented. +Other documentation mentioning the version should also be updated. At time of writing, that is the [supported platforms documentation](supported_platforms.md).