Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updating upgrading_to_new_versions_of_eos.md #1056

Merged
merged 2 commits into from
Dec 13, 2024
Merged

docs: Updating upgrading_to_new_versions_of_eos.md #1056

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7fa94e5
docs: Updating upgrading_to_new_versions_of_eos.md
WispyMouse Dec 12, 2024
99acef0
Update upgrading_to_new_versions_of_eos.md
WispyMouse Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions com.playeveryware.eos/Documentation~/upgrading_to_new_versions_of_eos.md
View file
Open in desktop
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).
Loading