Jedi Knight Galaxies (JKG) is a multiplayer shooter with role playing elements, played out in the Star Wars universe. The project is a full conversion game modification for Jedi Knight: Jedi Academy.
Travis CI no longer offers free builds and I don't really want to bother with them anymore since it seems like they're basically dead for open source at this point. Github Actions is free and we should probably move to this anyway. If someone wants to help with setting this up, I'd greatly appreciate it as I don't have much time to think about this and the game itself.
I put a discussion label on this, because I'd like to also ask if we should re-evaluate how we do builds and what a better way of doing it would be. Automagic would be best if possible. Some sort of testing might be nice too, not sure what would be good though. Here's some thoughts:
Builds:
develop is automatically built anytime a new commit is sent to it or a merge happens etc. Builds for windows on msvc, linux on clang/gcc , macOS on clang. Should do both a debug and release build (or just release?) If the build fails, ping the one responsible in Discord.
develop should maybe run some basic tests as well such as checking all ext_data is valid (so you can't commit bad json without getting an error etc). Maybe also check lua?
master behaves similarly to develop, but maybe has more in depth tests such as after successfully building and passing other tests: start the game (as a client and server separately), load up a map, join a team, shutdown. Report any crashes before shutdown as a failed test. Other testing?
master also automatically generates a windows binary zip (jkgalaxies.x86.exe, jkgalaxiesded.x86.exe, rd-galaxies_x86.dll, JKG/cgamex86.dll JKG/gamex86.dll, JKG/uix86.dll as well as packing the contents of the ext_data/JKGalaxies directory & JKGServer directory etc into JKG/zz_JKG_Assets5.pk3 as appropriate). Should also build similar binaries for linux and mac. Where to upload these? Want this on jkgalaxies.net?
If a beta/pre-release tag is created pull and build this from the current master
If a stable/normal release tag is created, a developer needs to verify each version manually by testing the executable and playing it on Windows, Linux and Mac before the release can be published.
other branches are not automatically built unless manually requested
asset integration somehow? need a proper host for this
also want something to update the jkgalaxies website with pre-release/beta and stable release info so I don't have to manually upload links etc.
automatically uploading to mirrors would be great too
Developer workflow (starting from a stable release):
switch to develop branch
increase version number (eg: v1.3.27 to v1.3.28)
work on features for next milestone
if you need to deviate from the milestone or work on a large feature, branch from develop to a new branch
4a. when finished with new feature, merge back into develop (update version number if appropriate)
when milestone is ready for next pre-release/beta, manually test build and then merge develop into master
build master and download binaries - test internally on all supported OSes (Windows 10, Ubuntu, MacOS Catalina) with developers
draft a new tag, write patch notes, upload binaries to it
upload/collect assets
publish tag
update links to assets and binaries on the jkgalaxies.net download webpage for beta/pre-releases
push changes/publish web page changes
upload to beta mirrors (only limited mirrors will support the beta)
update links to mirrors and push/publish web page changes
schedule 481st beta test match
test game, review reported bugs, repeat
15b. If bugs, switch back to develop, update version, then when bugs are fixed (try not to add any new features!) go back to step 5, release new beta and test again
15c. if no serious issues during play test, publish as stable release, otherwise repeat again
DarthFutuza
commented
2 years ago
Travis CI no longer offers free builds and I don't really want to bother with them anymore since it seems like they're basically dead for open source at this point. Github Actions is free and we should probably move to this anyway. If someone wants to help with setting this up, I'd greatly appreciate it as I don't have much time to think about this and the game itself.
I put a discussion label on this, because I'd like to also ask if we should re-evaluate how we do builds and what a better way of doing it would be. Automagic would be best if possible. Some sort of testing might be nice too, not sure what would be good though. Here's some thoughts:
Builds:
Developer workflow (starting from a stable release):