You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,3 +65,23 @@ the EOS Developer Portal.
65
65
66
66
After being installed via the Tool, update the repo [readme](/com.playeveryware.eos/README.md) to ensure it lists the correct version
67
67
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