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

added release instructions #278

Merged
merged 1 commit into from
Feb 4, 2025
Merged

added release instructions #278

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ The Sequence Unreal Embedded Wallet SDK provides full Sequence Embedded Wallet a

The SDK comes with a number of samples that can be imported used from the `SequencePlugin Content/Core` directory.

## How to release a new version

1. Increase the "VersionName" field inside the `SequencePlugin.uplugin` & `SequenceRPCManager.h` files.
2. Merge the `master` branch into the `5_2_downgrade` branch and check if it compiles.
3. Merge the `5_2_downgrade` branch into the `5_3_downgrade` branch and check if it compiles.
2. In the Unreal Editor, go inside the Plugins Window and package the plugin for all supported versions.
1. Before packaging, make sure to temporarily remove `IOS` from `SupportedTargetPlatforms`. Add it back to the list inside the packaged files.
2. Remove the `Intermediate` and `Binaries` inside the packaged folder.
3. Create a zip files of the packaged folder without compression.
1. MacOS command: `ditto -c -k --sequesterRsrc --keepParent --zlibCompressionLevel 0 ./SequencePlugin SequenceUnreal_1-5-0_UE-5-4.zip`
2. Windows PowerShell: `Compress-Archive -CompressionLevel NoCompression -Path 'SequencePlugin' -DestinationPath 'SequenceUnreal_1-5-0_UE-5-4.zip'`
3. Create a git tag of the `master` branch including the version name, like `Sequence_1_0_0`.
3. Create a release on GitHub, collect changelogs and upload the file builds for all supported versions.

## Upgrading to Unreal 5.4

If your project is currently on 5.2 or 5.3, then for this version you'll want to upgrade to 5.4. To do this close the Unreal Editor, Close your Code Editor. Right-click on your Unreal Project file. Then select Switch Unreal Engine Version, Choose 5.4 and click okay. Once done. Open your code editor and rebuild your source code.
Expand Down