How to release a new version
Export the Unreal Engine project for release
- Open the UE4Project in the Unreal Editor
- Ensure 'File' -> 'Package Project' -> 'Build configuration' is set to 'Shipping,
- Choose 'File' -> 'Package Project' -> 'Windows (64 bit)'
- Select any folder on your computer.
- Wait until it finishes.
- Go into the
WindowsNoEditor
folder and renameBlocks.exe
toFSDS.exe
- Zip all files and upload to github release!
Deploying documentation
For documentation we use mkdocs and mike. Hosting is provided by github pages.
To tag a new version of the documentation and release it to github, first checkout the version that you want to deploy.
Then run mike deploy VERSION latest -u -p
.
This will compile the documentation, store it as a new version in the gh-pages
branch, update the latest
alias to point at the new version and push the gh-pages
branch to github and thus making the documentation public.
To create a new version without updating the latest
tag, omit the latest -u
part.