Skip to content

Commit

Permalink
Merge pull request #1056 from PlayEveryWare/documentation/eos-sdk-cha…
Browse files Browse the repository at this point in the history
…ngelogs

docs: Updating upgrading_to_new_versions_of_eos.md
  • Loading branch information
WispyMouse authored Dec 13, 2024
2 parents 60eff8f + 99acef0 commit 6b832cf
Showing 1 changed file with 20 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 6b832cf

Please sign in to comment.