Skip to content

Commit 6b832cf

Browse files
authored
Merge pull request #1056 from PlayEveryWare/documentation/eos-sdk-changelogs
docs: Updating upgrading_to_new_versions_of_eos.md
2 parents 60eff8f + 99acef0 commit 6b832cf

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,23 @@ the EOS Developer Portal.
6565

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

0 commit comments

Comments
 (0)